Code Monkey home page Code Monkey logo

guiscord's Introduction

Guiscord

react logo

axios next typescript styled-components


All badges are links to each doc

Description of that project ๐Ÿ“–

Guiscord app is an POC that use nextjs and supabase to create a Discord based app. This app let you talk with user that you follow in github

Requirements ๐Ÿ›‘

Mandatory

For development, you will need some software installed in your environment.

Optional

To improve your experience and enjoy each linter, here are some extensions
For VSCode, if you use another editor, please look at your marketplace

Configuring your Project ๐Ÿงฐ

Yarn will install all dependencies into all projects, start and build them

yarn install
yarn start
yarn build

Project Folders Structure ๐Ÿ‘ท

.
โ”œโ”€โ”€ .vscode..............................# contains the settings to vscode;
โ”œโ”€โ”€ src..................................# source projects and packages folders were created here;
โ”‚    โ”œโ”€โ”€ apps............................# contain  all projects files and folders;
โ”‚    โ”‚   โ””โ”€โ”€ [project_folders]
โ”‚    โ””โ”€โ”€ packages........................# contains all packages that could be used by each app;
โ”‚        โ”œโ”€โ”€ assets......................# centralize animations, icons and images;
โ”‚        โ”‚   โ”œโ”€โ”€ animations..............# centralize animations and create React Components to each one;
โ”‚        โ”‚   โ”œโ”€โ”€ icons...................# centralize icons and create React Components to each one;
โ”‚        โ”‚   โ””โ”€โ”€ images..................# centralize images and create React Components to each one;
โ”‚        โ”œโ”€โ”€ components..................# contains shared components;
โ”‚        โ”‚   โ””โ”€โ”€ [components_folders]
โ”‚        โ”œโ”€โ”€ configs.....................# contains a config file that share info on project;
โ”‚        โ”œโ”€โ”€ context.....................# contains shared context;
โ”‚        โ”œโ”€โ”€ hooks.......................# contains shared hooks;
โ”‚        โ”‚   โ””โ”€โ”€ [hooks_files]
โ”‚        โ”œโ”€โ”€ pages.......................# contains shared pages;
โ”‚        โ”‚   โ””โ”€โ”€ [pages_folders]
โ”‚        โ”œโ”€โ”€ services....................# centralize icons and create React Components to each one;
โ”‚        โ””โ”€โ”€ styles......................# centralize icons and create React Components to each one;
โ”‚            โ”œโ”€โ”€ pages...................# contains styles of each page of project (it's an alternative to follow the good pratices on NextJs)
โ”‚            โ”œโ”€โ”€ theme...................# themes files are placed here
โ”‚            โ””โ”€โ”€ [...]...................# others global styles files
โ””โ”€โ”€ [...]................................# root files as environment, linters, etc;

Project Linters ๐Ÿงน

Project Maintenance ๐Ÿ‘จโ€๐Ÿ”ง

  • Project is using Angular Commits Guide Line, for more information, click on this link.

How this project can grow? ๐Ÿชด

  • Tests, tests and more tests
  • Apply internationalization would be a good option to turn it more world wide spread.
  • Maybe this project could be better with more themes

guiscord's People

Contributors

guimoraesdev avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.