Skip to content

Ansalpandey/Note-CRUD

Repository files navigation

📝 Notes CRUD API

This is a simple Notes CRUD (Create, Read, Update, Delete) API built using Node.js, Express, and Firebase Firestore. It includes basic validation, error handling, timestamps, and Swagger API documentation.

Run Locally

Clone the project

  git clone https://github.com/Ansalpandey/Note-CRUD.git

Go to the project directory

  cd Note-CRUD

Install dependencies

  npm install

Start the server

  npm run start

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

FIREBASE_SERVICE_ACCOUNT

Add Firebase Service Account credential in minified JSON

Features

  • Create a new note
  • Retrieve all notes
  • Retrieve a note by ID
  • Update a note by ID
  • Delete a note by ID
  • Includes Swagger API documentation
  • Uses Firebase Firestore as database
  • Timestamps (createdAt, updatedAt) included

Tech Stack

  • Backend: Node.js + Express.js
  • Database: Firebase Firestore
  • Validation: express-validator
  • Docs: Swagger

Authors

Documentation

API Documentation Link

License

MIT

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors