Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ENGINEERING] Frontend setup #2

Open
yxli001 opened this issue Jan 29, 2025 · 0 comments
Open

[ENGINEERING] Frontend setup #2

yxli001 opened this issue Jan 29, 2025 · 0 comments
Assignees
Labels

Comments

@yxli001
Copy link
Collaborator

yxli001 commented Jan 29, 2025

What is the issue?
Basic project structure set up

  • Make sure you have Node.js version >= 20
  • Initialize React project in a folder named frontend (highly recommend using vite), make sure TypeScript is used
  • Set up eslint and Prettier configs to ensure consistent code style across different developers
  • Set up a .gitignore to make sure secrets don't get pushed to GitHub
  • Set up a module path alias to avoid importing using relative paths like ../../../../../assets/picture.jpg
  • Create folders inside src/ for file organization (below are some common patterns, but feel free to use whatever feels most organized to you)
    • src/pages to put page components
    • src/components to put other smaller components
    • src/api for API calls
    • src/utils for miscellaneous utility functions
    • ...maybe more
  • Set up React Router in App.tsx, which should only route to a temporary home page at / for now
    • Potentially create a Layout component that renders general structures like navbars and footers on all routes nested under the same group

Additional resources

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: In Progress
Development

No branches or pull requests

3 participants