https://github.com/kinchan-code/todolist-api

A personal project for managing todos with basic user authentication
https://github.com/kinchan-code/todolist-api

express mongodb node typescript

Last synced: 2 months ago
JSON representation

A personal project for managing todos with basic user authentication

• Host: GitHub
• URL: https://github.com/kinchan-code/todolist-api
• Owner: Kinchan-code
• Created: 2024-11-13T18:19:30.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-18T14:21:06.000Z (over 1 year ago)
• Last Synced: 2025-01-29T16:29:58.104Z (over 1 year ago)
• Topics: express, mongodb, node, typescript
• Language: TypeScript
• Homepage: https://todo-list-api-18qw.onrender.com
• Size: 134 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# TodoList API

A personal project for managing todos with user authentication.

## Overview

This project is a simple API built with Node.js, Express, and MongoDB. It includes basic user authentication and CRUD operations for todo items.

## Setup

1. **Install dependencies:**

   Ensure you have Node.js and npm installed on your machine. Then, in the root directory of the project, run:

   ```bash

   npm install

   ```

   This will install all the necessary packages listed in `package.json`.

2. **Configure environment variables:**

   Create a `.env` file in the root directory. This file should contain the necessary environment variables for the project. Here is an example of what might be included:

   ```plaintext

   PORT=3000

   MONGODB_URI=your_mongodb_connection_string

   JWT_SECRET=your_jwt_secret_key

   ```

   Replace the placeholder values with your actual configuration details.

3. **Run the project:**

   - **For development:**

     Use the following command to start the development server with hot-reloading:

     ```bash

     npm run dev

     ```

     This will use `nodemon` to automatically restart the server when file changes are detected.

   - **For production:**

     To run the project in a production environment, use:

     ```bash

     npm start

     ```

     This will start the server using `node`, without hot-reloading.

4. **Access the API:**

   Once the server is running, you can access the API at `http://localhost:3000` (or the port you specified in the `.env` file).

5. **Testing:**

   If you have tests set up, you can run them using:

   ```bash

   npm test

   ```

   Ensure all tests pass before deploying to production.

## API Endpoints

- **Authentication:**

  - `POST /api/auth/signup` - Register a new user

  - `POST /api/auth/login` - Login a user

  - `POST /api/auth/logout` - Logout a user

  - `POST /api/auth/change-password` - Change user password

  - `GET /api/auth/check-auth` - Check user authentication status

- **Todos:**

  - `GET /api/todos` - Get all todos

  - `GET /api/todo/:id` - Get a single todo

  - `POST /api/add-todo` - Create a new todo

  - `PUT /api/update-todo/:id` - Update a todo

  - `DELETE /api/delete-todo/:id` - Delete a todo

## License

This project is for personal use only. All rights reserved.

## Contact

For questions or feedback, please contact [chanbangay@gmail.com](mailto:chanbangay@gmail.com).