The Personal Notes API is a powerful backend service for managing personal notes through RESTful endpoints. This API allows users to create, edit, delete, and organize their notes programmatically.
- Create new notes
- Update existing notes
- Delete notes
- Clone this repository:
cd personal-notes-api
-
Install dependencies:
yarn -
Set up your database configuration in
.env, from.default.env. -
Run the application:
yarn start:dev
Comprehensive documentation for all endpoints is available through Swagger and can be accessed at /docs.
This project follows the Repository Design Pattern to separate the data access layer from the business logic. The pattern provides a structured and efficient way to interact with the database, making the code more maintainable and testable.