Clever todo list

Deployment

Tech Stack

• React
• MUI
• Firebase
• TypeScript

How to run the app

1. Clone this repository by running $ git clone https://github.com/lnicepei/clever-todo-list
2. Run cd clever-todo-list
3. Run npm i
4. Run npm run dev

Other scripts

• npm run lint wil run eslint in the source folder, checking for all files that match the following pattern src/**/*.ts{,x}

How to add git hooks

• Run npm run prepare
• Add a hook. npx husky add .husky/pre-commit "npm test", for instance

Firebase snapshot

• Tasks
  • Stored as an array
  • Each user has their own tasks
  • You can modify a task. Create, Read, Update, Delete
• Users
  • Log in
  • Register
  • Use Google to see their tasks

Folder structure

• Project boilerplate was created using vite
• React Router's routes can be found in src/pages folder
• The components that cannot be accessed by navigation, i.e. building blocks of pages are located inside src/components folder
• The components that serve a specific task, but are not a building block of a larger component(helper components, such as Toasters or Loaders) were placed to src/helpers directory
• Mui theme-related code was put to src/themes folder