Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leonardospereira/to-do-list
An to-do app created with TypeScript and React
https://github.com/leonardospereira/to-do-list
css-modules reactjs typescript vite
Last synced: about 1 month ago
JSON representation
An to-do app created with TypeScript and React
- Host: GitHub
- URL: https://github.com/leonardospereira/to-do-list
- Owner: LeonardoSPereira
- Created: 2024-03-26T12:30:41.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-14T12:19:53.000Z (6 months ago)
- Last Synced: 2024-10-09T21:05:21.860Z (about 1 month ago)
- Topics: css-modules, reactjs, typescript, vite
- Language: TypeScript
- Homepage:
- Size: 600 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# To-Do List
## Table of Contents
- [About](#about)
- [Getting Started](#getting_started)
- [Usage](#usage)
- [Technologies](#technologies)
## About
- This is a simple to-do list application that allows you to add, remove and mark tasks as done. It was developed using React.js and css-modules.
- The app is responsive and can be used on mobile devices.
- The app already has some tasks added to it, but you can remove them and add your own tasks. You can find this tasks in the file `src/App.tsx`, inside the `tasks` state.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
- You need to have Node.js installed on your machine. You can download it [here](https://nodejs.org/en/).
- You need to have a package manager installed on your machine. You can use npm or pnpm. In this project, I used pnpm. You can download it using the following command:
```bash
npm install -g pnpm
```
### Installing
A step by step series of examples that tell you how to get a development env running.
1. Clone the repository:
```bash
git clone https://github.com/LeonardoSPereira/To-Do-List
```
2. Install the dependencies:
```bash
pnpm install
```
or
```bash
npm install
```
This instructions will help you to run the project on your local machine.
With the dependencies installed, you can run the project using the following command:
```bash
pnpm run dev
```
or
```bash
npm run dev
```
## Technologies
- [React.js](https://reactjs.org/)
- [TypeScript](https://www.typescriptlang.org/)
- [Css-modules](https://github.com/css-modules/css-modules)
- [pnpm](https://pnpm.io/)
- [Vite](https://vitejs.dev/)
- [Phosphor Icons](https://phosphoricons.com/)