Skip to content

fpelletier-gh/rest-api-todolist

Repository files navigation

TodoList and Notes API

This is a REST API for a TodoList and Notes application. The API is built using Node.js, TypeScript, and MongoDB as a database. Zod is used for data validation, Jest for unit testing, and Supertest for integration testing.

Getting Started

Prerequisites

Make sure you have Node.js and MongoDB installed on your system.

Installing

  1. Clone this repository
  2. Run npm install to install the dependencies
  3. Create a .env file from .dist.env:
cp .dist.env .env
  1. Run npm run start to start the server

Documentation

Swagger Documentation

Testing

To run the unit tests, run npm run test.

Built With

License

This project is licensed under the MIT License - see the LICENSE file for details.

Releases

No releases published

Packages

No packages published