README.md

Nest Notes API

This is a simple notes project for testing Nest (Node.js framework).

How to test the project:

• Clone:

git clone https://github.com/hydra13/nest-notes-api.git

• Install depedences:

cd nest-notes-api
npm i

• Configure your MongoDB connection in:

src/config/keys.ts

• Start service:

npm start

API

1. Get all notes:

GET /notes 

2. Get note by ID

GET /notes/:id 

3. Create new note:

POST /notes 
{
  title: :title,
  text: :text
}

4. Update note by ID:

PUT /notes/:id
{
  title: :title,
  text: :text
}

5. Delete note by ID:

DELETE /notes/:id`;

Used:

• TypeScript
• Node.js
• MongoDB (Mongo Cloud - https://cloud.mongodb.com/)
• Nest.js