Skip to content

201flaviosilva/To-Do-List

Repository files navigation

To-Do-List

Description

My goal with this project is to learn how to use multiple FE technologies together, while using it I develop a simple application like a to do list

  • Login/sign up/guest mode system;
  • Create a new task;
  • Search the list;
  • Remove:
    • Individually;
    • All;
    • Completed;
    • Repeated;
  • Save in local Storage;
  • Favorites;
  • Individual changes:
    • Mark as completed;
    • Mark as favorite;
    • Change the title of the task;

Used Technologies

  • Vite
  • ESLint
  • TypeScript
  • Styled Components
  • Redux
  • React Router
  • JestTesting-Library
  • Cypress
  • Storybook
  • Electron
  • GitHub
    • Issues;
    • Pull Requests;
    • Projects;
    • Wiki;
    • Milestones;
    • GitHub Actions

Make it run

Clone and change directory

Clone the project and move it into the project folder:

git clone https://github.com/201flaviosilva/To-Do-List.git
cd To-Do-List

Install the dependencies

To install the node dependencies, you need to have node and npm installed in you machine.

npm i

Start the app

To make the app running and open a browser window just run:

npm start

Start the Storybook

Check the components documentation:

npm run storybook

Available Commands

Command Description
npm run clear Delete the build and out and dist folder
npm i Install project dependencies
npm start Start project and open web server running project
npm run build Builds code bundle with production settings (minification, uglification, etc..)
npm run preview Start a local development server with Vite and preview the application
npm run lint Fix code styles and some problems
npm run analyze Builds the project and analyzes the size code bundle
npm run depcheck Prints the not used dependencies
npm run bump Updates the package version and creates a new tag on github