CONTRIBUTING.md

Contribution Guide

Project Structure

• /src - Source code
  • main.tsx - EntryPoint (Provider chain etc)
  • App.tsx - Root component
  • /@types - Type definitions
  • /components - Button, Card, Calendar, ...
  • /hooks - Custom hooks
  • /modules - API, Authentication, ...
  • /pages - Page components
  • /store - Global states
  • /utils - Utilities

Libraries

• vitejs/vite - Frontend buliding tool
• facebook/react - Main UI library
• remix-run/react-router - Routing library
• chakra-ui/chakra-ui - Component library
• TanStack/query - Asynchronous state management library (Mainly used for data fetching)
• facebookexperimental/recoil - State management library

Other tools

• ESLint - Linter, See .eslintrc.json
• Prettier - Code Formatter, See .prettierrc
• okonet/lint-staged / Husky - Pre-commit linter runner

Dev

1. yarn install
2. yarn dev or yarn dev --host

Build

yarn build

Links

• Demo page
• Staging page
• Project board

Reference

• React documentation
• Chakra UI documentation
• Tanstack Query documentation
• React Router documentation
• Recoil documentation
• Vite PWA Plugin documentation