Skip to content

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

Notifications You must be signed in to change notification settings

GuiMoraesDev/Guiscord

Repository files navigation

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

About

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

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages