https://github.com/emilioddev/taskjs
RESTful API built with Express.js and Node.js that allows users to register accounts, log in, and manage personal tasks.
https://github.com/emilioddev/taskjs
api expressjs js json jwt-authentication mongodb nodejs rest-api
Last synced: 2 months ago
JSON representation
RESTful API built with Express.js and Node.js that allows users to register accounts, log in, and manage personal tasks.
- Host: GitHub
- URL: https://github.com/emilioddev/taskjs
- Owner: EmiliodDev
- License: mit
- Created: 2024-08-01T16:09:20.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T17:07:08.000Z (almost 2 years ago)
- Last Synced: 2025-03-20T13:44:21.812Z (over 1 year ago)
- Topics: api, expressjs, js, json, jwt-authentication, mongodb, nodejs, rest-api
- Language: JavaScript
- Homepage:
- Size: 8.21 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TaskJS
     
**TaskJS** is a RESTful API built with **Express.js** and **Node.js** that allows users to register accounts, log in, and manage personal tasks. The API uses **JSON Web Tokens (JWT)** for authentication and **MongoDB** for data storage via **Mongoose**.
## Features
- **User Registration and Authentication**: Enables user sign-up and login with JWT for secure access.
- **Task Management**: Full CRUD (Create, Read, Update, Delete) functionality for personal tasks.
- **Protected Routes**: Secure access to routes using JWT authentication.
- **MongoDB with Mongoose**: Simplified database interactions for managing MongoDB documents.
## Technologies Used
- **Node.js**: JavaScript runtime environment for the server.
- **Express.js**: Web application framework built on Node.js.
- **MongoDB**: NoSQL database to store users and tasks.
- **Mongoose**: ODM to facilitate MongoDB interactions.
- **JSON Web Tokens (JWT)**: Secure method for user authentication.
- **bcrypt.js**: Library for password hashing.
## Installation
Follow these steps to install and run the project locally:
1. **Clone the repository**:
```bash
git clone https://github.com/EmiliodDev/TaskJS.git
cd TaskJS
```
2. **Install the dependencies**:
```bash
npm install
```
3. **Set up environment variables**:
Create a `.env` file in the root directory of the project with the following information:
```.env
MONGO_URI=
JWT_SECRET=
```
4. **Start the server**:
```bash
node server/main.js
```
## Endpoints
| Method | URL | Action |
|--------|-----|--------|
|POST |/register| register a user|
|POST| /login| logs in a user |
|POST|/tasks/:userId|creates a new task associated with the specified user|
|PUT|/tasks/:taskId| updates an existing task|
|GET|/tasks|retrieves all the user's tasks|
|DELETE | /tasks/:taskId| delete a specified task|
Go to:
- [Register](#register)
- [Login](#login)
- [Create a new task](#create-task)
- [Update a task](#update-task)
- [Get a list of tasks](#get-all-tasks)
- [Delete a task](#delete-task)
### **Register**
Register a new user with the credentials provided.
|**URL**|**Method**|**Request params**|
|-------|----------|------------------|
|`/register`|`POST`|`none`|
- **Request Body:**
```json
{
"username": "example",
"password": "password123",
"email": "example@email.com"
}
```
- **Successful response**
- Code: 201 (Created)
- Response Body:
```json
{
"message": "user created"
}
```
- **Error Response**
- Code: 400 (Bad Request)
- Response Body:
```json
{
"error": "User already exists"
}
```
- Code: 500 (Internal Server Error)
- Response Body:
```json
{
"error": "Something went wrong"
}
```
> Note: You can see an example usage in `examples/register.js`
### **Login**
Logs in a user with the provided credentials.
|**URL**|**Method**|**Request params**|
|-------|----------|------------------|
|`/login`|`POST`|`none`|
- **Request Body:**
```json
{
"email": "example@example.com",
"password": "password123"
}
```
- **Successful Response**
- Code: 200 (OK)
- Response Body:
```json
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
```
- **Error response**
- Code: 401 (Unauthorized)
- Response Body:
```json
{
"error": "Invalid username or password"
}
```
- Code: 500 (Internal Server Error)
- Response Body:
```json
{
"error": "Something went wrong"
}
```
> Note: You can see an example usage in `examples/login.js`
### **Create Task**
Creates a new task associated with the specified user.
|**URL**|**Method**|**URL Parameters**|**Headers**|
|-------|----------|------------------|-----------|
|`/tasks/:userId`|`POST`|`userId` - The ID of the user to associate the task with.|`Authorization: Bearer ` - The access token obtained after logging in.|
- **Request Body**
- `title` (required): The title of the task.
- `isCompleted`: Indicates whether the task is completed (default: `false`).
- `description`: The description of the task.
- `time`: The time associated with the task.
- `date`: The date of the task.
- `iisNotificationEnabled`: Indicates whether notifications are enabled for the task (default: `false`).
- `repeatDays`: An array of days when the task is repeated.
- **Successful Response**
- Code: 200 (OK)
- Response Body:
```json
{
"message": "Task created",
"task": {
"_id": "task_id",
"title": "Task Title",
"isCompleted": false,
"description": "Task Description",
"time": "Task Time",
"date": "Task Date",
"isNotificationEnabled": false,
"repeatDays": ["Monday", "Wednesday"],
"user": "user_id",
"createdAt": "2023-06-07T12:00:00Z",
"updatedAt": "2023-06-07T12:00:00Z"
}
}
```
- **Error Response**
- Code: 500 (Internal Server Error)
- Response Body:
```json
{
"error": "Something went wrong"
}
```
> Note: You can see an example usage in `examples/createTask.js`
### **Update Task**
Updates an existing task
|**URL**|**Method**|**URL Parameters**|**Headers**|
|-------|----------|------------------|-----------|
|`/tasks/:taskId`|`PUT`|`taskId` - The ID of the task to be updated.|`Authorization: Bearer ` - The access token obtained after logging in.|
- **Request Body**
- `title` (required): The title of the task.
- `isCompleted`: Indicates whether the task is completed (default: `false`).
- `description`: The description of the task.
- `time`: The time associated with the task.
- `date`: The date of the task.
- `iisNotificationEnabled`: Indicates whether notifications are enabled for the task (default: `false`).
- `repeatDays`: An array of days when the task is repeated.
- **Successful Response**
- Code: 200 (OK)
- Response Body:
```json
{
"message": "Task updated",
"task": {
"_id": "task_id",
"title": "Updated Task Title",
"isCompleted": true,
"description": "Updated Task Description",
"time": "Updated Task Time",
"date": "Updated Task Date",
"isNotificationEnabled": true,
"repeatDays": ["Monday", "Tuesday"],
"user": "user_id",
"createdAt": "2023-06-07T12:00:00Z",
"updatedAt": "2023-06-07T12:30:00Z"
}
}
```
- **Error Response**
- Code: 404 (Not Found)
- Response Body:
```json
{
"message": "Task not found"
}
```
> Note: You can see an example usage in `examples/updateTask.js`
### **Get All Tasks**
Retrieves all the user's tasks
|**URL**|**Method**|**Headers**|
|-------|----------|-----------|
|`/tasks`|`GET`|`Authorization: Bearer ` - The access token obtained after logging in.|
- **Successful Response**
- Code: 200 (OK)
- Response Body:
```json
{
"tasks": [
{
"_id": "task_id1",
"title": "Task 1",
"isCompleted": false,
"description": "Task 1 description",
"time": "09:00",
"date": "2023-06-07",
"isNotificationEnabled": true,
"repeatDays": ["Monday", "Wednesday"],
"user": "user_id",
"createdAt": "2023-06-07T08:00:00Z",
"updatedAt": "2023-06-07T09:30:00Z"
},
{
"_id": "task_id2",
"title": "Task 2",
"isCompleted": true,
"description": "Task 2 description",
"time": "13:00",
"date": "2023-06-08",
"isNotificationEnabled": false,
"repeatDays": [],
"user": "user_id",
"createdAt": "2023-06-07T10:00:00Z",
"updatedAt": "2023-06-07T11:45:00Z"
}
]
}
```
- **Error Response**
- Code: 500 (Internal Server Error)
- Response Body:
```json
{
"error": "Something went wrong"
}
```
> Note: You can see an example usage in `examples/getAllTasks.js`
### **Delete Task**
Delete a task.
|**URL**|**Method**|**Headers**|**URL Parameters**|
|-------|----------|-----------|------------------|
|`/tasks/:taskId`|`DELETE`| `Authorization: Bearer ` - The access token obtained after logging in.|`taskId` - The ID of the task to delete.|
- **Successful Response**
- Code: 200 (OK)
- Response Body:
```json
{
"message": "Task deleted successfully"
}
```
- **Error Response**
- Code: 400 (Bad request)
- Response Body:
```json
{
"message": "Task not found"
}
```
- Code: 500 (Internal Server Error)
- Response Body:
```json
{
"error": "Something went wrong"
}
```
> Note: You can see an example usage in `examples/deleteTask.js`
# License
Licensed under:
- MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)