Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/badiwidya/to-do-list-api
Todolist REST API
https://github.com/badiwidya/to-do-list-api
cors crud express mongoose morgan nodejs rest-api todolist typescript
Last synced: 4 days ago
JSON representation
Todolist REST API
- Host: GitHub
- URL: https://github.com/badiwidya/to-do-list-api
- Owner: badiwidya
- Created: 2024-12-01T10:04:34.000Z (25 days ago)
- Default Branch: main
- Last Pushed: 2024-12-01T10:05:43.000Z (25 days ago)
- Last Synced: 2024-12-01T11:19:25.242Z (25 days ago)
- Topics: cors, crud, express, mongoose, morgan, nodejs, rest-api, todolist, typescript
- Language: TypeScript
- Homepage:
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Get Started
This is a to do list REST API, integrated with Mongoose to organize tasks along with custom tags.
## Installation
1. Clone the repository:
```sh
git clone https://github.com/badiwidya/to-do-list-api.git
```
2. Navigate to the project directory:
```sh
cd to-do-list-api
```
3. Install dependencies:
```sh
npm install
```
## Usage
1. Run npm build:
```sh
npm run build
```
2. Start the project:
```sh
npm start
```
3. Use an API client like Postman to interact with the endpoints.
## Endpoints
### Tasks
- `GET /tasks` - Get all tasks
- `POST /tasks` - Create a new task
- `PUT /tasks/:id` - Edit a task
- `DELETE /tasks/:id` - Delete a task
### Tags
- `GET /tags` - Get all tags
- `POST /tags` - Create a new tag
- `DELETE /tags/:id` - Delete a tag
*I am still learning, if there is a need to fix, please tell me.*