smallpaes / ts-todo-list-frontend

A todo list app built using React, TypeScript, Vite, TanStack Query, and Material UI

Todo List

A todo list app built using React, TypeScript, Vite, TanStack Query and Material UI

Requirements

To run this project, you will need:

• Node.js (version 18.0 or above)

Installation

To install the project, please follow these steps:

1. Clone the repository to your local machine.

git clone https://github.com/smallpaes/ts-todo-list-frontend.git

2. Open a terminal and navigate to the project directory.

cd ts-todo-list-frontend

3. Run the following command to install the dependencies:

npm install

Usage

To start the development server, run the following command:

npm run dev

This will start a development server at http://localhost:5173. You can access the application in your web browser at that address.

To build the production version of the project, run the following command:

npm run build

This will generate a dist folder with the optimized and minified version of your project.

Technologies

This project was created using the following technologies:

• React (version 18.2)
• Vite (version 4.3)
• TypeScript (version 5.0)
• Material UI (version 5.12)
• TanStack Query (version 4.29.5)
• TanStack Query Devtools (version 4.29.6)

Folder Structure

The project's folder structure is as follows:

├── public
├── src
│   ├── apis
│   ├── assets
│   ├── components
│   ├── pages
│   ├── theme
│   ├── App.tsx
│   ├── index.css
│   ├── main.tsx
│   └── vite-env.d.ts
├── .eslintrc.cjs
├── .prettierrc.cjs
├── index.html
├── package.json
├── README.md
├── tsconfig.json
├── tsconfig.node.json
└── vite.config.ts