https://github.com/akashchouhan16/keepnote-api

A note-keeping API with routes for CRUD operations.
https://github.com/akashchouhan16/keepnote-api

hacktoberfest2021 hactoberfest mongodb nodejs rest-api

Last synced: 2 months ago
JSON representation

A note-keeping API with routes for CRUD operations.

• Host: GitHub
• URL: https://github.com/akashchouhan16/keepnote-api
• Owner: akashchouhan16
• License: mit
• Created: 2021-03-29T16:19:38.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2021-11-21T19:14:39.000Z (over 4 years ago)
• Last Synced: 2025-07-26T15:54:13.632Z (11 months ago)
• Topics: hacktoberfest2021, hactoberfest, mongodb, nodejs, rest-api
• Language: JavaScript
• Homepage:
• Size: 3.65 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# KeepNotes REST API

**API** for web applications which stores notes. This **CRUD API** is built using [Node](https://nodejs.org/en/) and [Express](https://expressjs.com/) and fetches data from [MongoDB](https://www.mongodb.com/).

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)

[![Ask Me Anything !](https://img.shields.io/badge/Ask%20me-anything-1abc9c.svg)](https://GitHub.com/Naereen/ama)

[![made-for-VSCode](https://img.shields.io/badge/Made%20for-VSCode-1f425f.svg)](https://code.visualstudio.com/)

[![GitHub issues](https://img.shields.io/github/issues/akashchouhan16/KeepNotes_API.svg)](https://GitHub.com/akashchouhan16/KeepNotes_API/issues/)

---

## Installation

- **Install All Dependencies**

  ```

    npm install

  ```

  >  OR 

  ```

    npm i --save

  ```

- **Create a `.env` file and add local or cloud (ATLAS) DataBase Connection URI**

  ```

     DB_URL='mongodb://localhost:27017/'

     DB_URL='mongodb+srv://username:password@cluster0.c1tnc.mongodb.net/myFirstDatabase?retryWrites=true&w=majority'

  ```

* **Add Collection `env` for MongoDB connection.**

  ```

     COLLECTION=''

  ```

- **Run the Development Server**

  ```sh-session

      npm run dev

  ```

* **Visit `http://localhost:5000/`**

---

## To access in a Docker container :

1. Build a Docker container :

   - ```

       docker build -t keepnotes-api .

     ```

2. Run the docker container in either mode `[interative with -it flag / detached with -d flag]`

   - ```

     docker run -it -p 5000:5000 keepnotes-api

     ```

---

## Preview

![Alt Text](main.gif)

---

## Routes

- > **Home : `localhost:5000/`**

- > **View all the notes `localhost:5000/api/`**

- > **Add new note `localhost:5000/api/newnote`**

- > **Update a note `locahost:5000/api/notes/:noteId`**

- > **Delete a note `localhost:5000/api/notes/:noteId`**

---

## [Application Info](https://github.com/akashchouhan16/KeepNotes_API "View API")

### Version

**[1.0.1](https://github.com/akashchouhan16/KeepNotes_API "API Version")**

### License

**[MIT](https://github.com/akashchouhan16/KeepNotes_API/blob/main/LICENSE "API LICENSE")**

> All rights reserved. Copyright (c) **Akash Chouhan**.

[![forthebadge](https://forthebadge.com/images/badges/powered-by-black-magic.svg)](https://forthebadge.com)

[![forthebadge](https://forthebadge.com/images/badges/made-with-javascript.svg)](https://forthebadge.com)