{"id":17675647,"url":"https://github.com/akashchouhan16/keepnote-api","last_synced_at":"2026-04-13T09:32:24.062Z","repository":{"id":45999464,"uuid":"352707871","full_name":"akashchouhan16/KeepNote-API","owner":"akashchouhan16","description":"A note-keeping API with routes for CRUD operations.","archived":false,"fork":false,"pushed_at":"2021-11-21T19:14:39.000Z","size":3827,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-26T15:54:13.632Z","etag":null,"topics":["hacktoberfest2021","hactoberfest","mongodb","nodejs","rest-api"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/akashchouhan16.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-03-29T16:19:38.000Z","updated_at":"2023-01-25T16:00:50.000Z","dependencies_parsed_at":"2022-08-25T09:20:55.571Z","dependency_job_id":null,"html_url":"https://github.com/akashchouhan16/KeepNote-API","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/akashchouhan16/KeepNote-API","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akashchouhan16%2FKeepNote-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akashchouhan16%2FKeepNote-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akashchouhan16%2FKeepNote-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akashchouhan16%2FKeepNote-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akashchouhan16","download_url":"https://codeload.github.com/akashchouhan16/KeepNote-API/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akashchouhan16%2FKeepNote-API/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31746294,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T09:16:15.125Z","status":"ssl_error","status_checked_at":"2026-04-13T09:16:05.023Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest2021","hactoberfest","mongodb","nodejs","rest-api"],"created_at":"2024-10-24T07:23:00.252Z","updated_at":"2026-04-13T09:32:24.044Z","avatar_url":"https://github.com/akashchouhan16.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# KeepNotes REST API\n\n**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/).\n\n[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)\n[![Ask Me Anything !](https://img.shields.io/badge/Ask%20me-anything-1abc9c.svg)](https://GitHub.com/Naereen/ama)\n[![made-for-VSCode](https://img.shields.io/badge/Made%20for-VSCode-1f425f.svg)](https://code.visualstudio.com/)\n[![GitHub issues](https://img.shields.io/github/issues/akashchouhan16/KeepNotes_API.svg)](https://GitHub.com/akashchouhan16/KeepNotes_API/issues/)\n\n---\n\n## Installation\n\n- **Install All Dependencies**\n  ```\n    npm install\n  ```\n  \u003e \u003cstrong\u003e\u003ccenter\u003e OR \u003c/center\u003e\u003c/strong\u003e\n  ```\n    npm i --save\n  ```\n- **Create a `.env` file and add local or cloud (ATLAS) DataBase Connection URI**\n\n  ```\n     DB_URL='mongodb://localhost:27017/\u003ccollectionName\u003e'\n     DB_URL='mongodb+srv://username:password@cluster0.c1tnc.mongodb.net/myFirstDatabase?retryWrites=true\u0026w=majority'\n  ```\n\n* **Add Collection `env` for MongoDB connection.**\n  ```\n     COLLECTION='\u003ccollectionName\u003e'\n  ```\n\n- **Run the Development Server**\n  ```sh-session\n      npm run dev\n  ```\n\n* **Visit `http://localhost:5000/`**\n\n---\n\n## To access in a Docker container :\n\n1. Build a Docker container :\n   - ```\n       docker build -t keepnotes-api .\n     ```\n2. Run the docker container in either mode `[interative with -it flag / detached with -d flag]`\n   - ```\n     docker run -it -p 5000:5000 keepnotes-api\n     ```\n\n---\n\n## Preview\n\n![Alt Text](main.gif)\n\n---\n\n## Routes\n\n- \u003e **Home : `localhost:5000/`**\n- \u003e **View all the notes `localhost:5000/api/`**\n- \u003e **Add new note `localhost:5000/api/newnote`**\n- \u003e **Update a note `locahost:5000/api/notes/:noteId`**\n- \u003e **Delete a note `localhost:5000/api/notes/:noteId`**\n\n---\n\n## [Application Info](https://github.com/akashchouhan16/KeepNotes_API \"View API\")\n\n### Version\n\n**[1.0.1](https://github.com/akashchouhan16/KeepNotes_API \"API Version\")**\n\n### License\n\n**[MIT](https://github.com/akashchouhan16/KeepNotes_API/blob/main/LICENSE \"API LICENSE\")**\n\n\u003e All rights reserved. Copyright (c) **Akash Chouhan**.\n\n[![forthebadge](https://forthebadge.com/images/badges/powered-by-black-magic.svg)](https://forthebadge.com)\n[![forthebadge](https://forthebadge.com/images/badges/made-with-javascript.svg)](https://forthebadge.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakashchouhan16%2Fkeepnote-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakashchouhan16%2Fkeepnote-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakashchouhan16%2Fkeepnote-api/lists"}