Skip to content

KhalidSaifullahFuad/notes-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

notes-api

Status GitHub Issues GitHub Pull Requests License

A RESTful notes API built with ExpressJS and MongoDB


AboutGetting StartedDeploymentBuilt UsingAcknowledgments



🧐 About

This API allows you to create, retrieve, update, and delete notes just like in a traditional notes app. You can use it to build your own notes app or integrate it into an existing project.

Check out the frontend for this API here: react-note-app


🏁 Getting Started

To get started with this project, follow these steps:

Clone the repository:

git clone https://github.com/user/notes-api.git

Install dependencies:

npm install

Start the development server:

npm start

🚀 Deployment

To deploy this API on a live system, you will need to have a MongoDB server running and connect the API to it by setting the MONGODB_URI environment variable. You can then build the API for production by running

npm run build

and start the production server with

npm start:prod

⛏️ Built Using


About

A RESTful notes API built with ExpressJS and MongoDB

Topics

Resources

License

Stars

Watchers

Forks