Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/viniciusbessa/bun_todos
This repository hosts a simple TODO API built with Express.js and executed using Bun.
https://github.com/viniciusbessa/bun_todos
ajv api bun docker expressjs mongodb mongoose swagger typescript
Last synced: 5 days ago
JSON representation
This repository hosts a simple TODO API built with Express.js and executed using Bun.
- Host: GitHub
- URL: https://github.com/viniciusbessa/bun_todos
- Owner: ViniciusBessa
- License: mit
- Created: 2024-01-29T03:31:53.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-02-13T20:27:54.000Z (9 months ago)
- Last Synced: 2024-02-13T21:33:48.688Z (9 months ago)
- Topics: ajv, api, bun, docker, expressjs, mongodb, mongoose, swagger, typescript
- Language: TypeScript
- Homepage:
- Size: 85.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bun TODO
This is a simple TODO API built using the Express.js framework and executed using Bun.
## Features
Authentication: Users can sign up, log in, and log out securely.
Account Management: Users can update their profile information and change passwords.
Tasks: Users can manage their TODO tasks by creating, reading, updating, and deleting them.
## Getting Started
1. Clone the repository:
```bash
git clone https://github.com/your-username/todo-api.git
```
2. Install dependencies:
```bash
npm install
```
or
```bash
bun install
```
3. Set up environment variables:
Create a .env file in the root directory of the project and define the following environment variables:
- JWT_SECRET=your_secret_key
- MONGO_URI=your_database_connection_string
Make sure to replace your_secret_key with your secret key for JWT token signing and your_database_connection_string with your MongoDB connection string.
4. Run the application:
```bash
bun run start
```
Access the API at http://localhost:5000.
## API Endpoints
### Auth
POST /api/v1/auth/register: Register a new user.
POST /api/v1/auth/login: Log in an existing user.
GET /api/v1/auth/account: Get the current user's profile.
### Users
GET /api/v1/users/:userId: Get an user's profile.
PUT /api/v1/users/:userId: Update an user's profile.
DELETE /api/v1/users/account: Delete the current user's account.
DELETE /api/v1/users/:userId: Delete an user's account.
### Tasks
GET /api/v1/tasks: Get all tasks.
POST /api/v1/tasks: Create a new task.
GET /api/v1/tasks/:taskId: Get a task by ID.
PUT /api/v1/tasks/:taskId: Update a task by ID.
DELETE /api/v1/tasks/:taskId: Delete a task by ID.
## License
This project is licensed under the MIT License.