{"id":50288625,"url":"https://github.com/codewithveek/note-api","last_synced_at":"2026-05-28T04:04:17.213Z","repository":{"id":146437464,"uuid":"486090572","full_name":"codewithveek/note-api","owner":"codewithveek","description":"Note API built with NodeJS, Express and HarperDB.","archived":false,"fork":false,"pushed_at":"2022-11-11T10:02:13.000Z","size":181,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-04T14:37:17.901Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"note-api-chi.vercel.app","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/codewithveek.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-04-27T07:29:44.000Z","updated_at":"2022-11-11T09:37:42.000Z","dependencies_parsed_at":"2023-03-30T17:22:58.945Z","dependency_job_id":null,"html_url":"https://github.com/codewithveek/note-api","commit_stats":null,"previous_names":["darkcodewrangler/note-api","codewithveek/note-api"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/codewithveek/note-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codewithveek%2Fnote-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codewithveek%2Fnote-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codewithveek%2Fnote-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codewithveek%2Fnote-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codewithveek","download_url":"https://codeload.github.com/codewithveek/note-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codewithveek%2Fnote-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33593420,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-28T02:00:06.440Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2026-05-28T04:04:11.108Z","updated_at":"2026-05-28T04:04:17.206Z","avatar_url":"https://github.com/codewithveek.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# note-api\n\nNote API built with NodeJS, Express and HarperDB.\n\nYou can find the article for this API [here](https://viblog.hashnode.dev/build-a-note-keeping-api-with-nodejs-express-and-harperdb).\n## How to use.\n\nClone the repo\n\n```\ngit clone https://github.com/Lucky-victory/note-api\n```\n\nMove into the directory\n\n```\ncd note-api\n```\n\nCopy the `.env.example` file to the `.env` file\n\n```\ncp .env.example .env\n```\n\nFill out the following placeholders with correct details.\n\u003e if you don't have a HarperDB account, you can [sign up](https://harperdb.io?utm_source=luckyvictory) for a free account.\n- `DB_HOST`: your HarperDB instance URL, e.g https://xxxxxxxxx.harperdbcloud.com\n- `DB_USER`: your HarperDB instance username.\n- `DB_PASS`: your HarperDB instance password.\n\nNow, Run the following commands.\n\n```\n npm install\n npm run db:init\n npm run start\n```\n\n## Routes for the API\n\n\u003e except for the **account** route, every other route requires an apikey to be passed as a query parameter.\n\n- **/account**\n  - `/sign-up [method=post]`: to register a new user.\n  - `/sign-in [method=post]` : to log in a user.\n- **/notes**`[method=get]`: fetch a user's notes.\n  - `/new [method=post]`: add a new note.\n  - `/edit/:id [method=put]`: edit a note by its ID.\n  - `/to-trash:id [method=put]`: move a note to trash.\n  - `/out-of-trash:id [method=put]`: remove a note from the trash.\n- **/tokens**\n  - `/new [method=post]`: generate a new apikey.\n  - `/revoke/:apikeyToRevoke [method=put]`: revoke an apikey.\n  - `/drop/:apikeyToDrop [method=delete]`: discard an apikey.\n- **/trash** `[method=get]`: fetch notes in trash.\n  - `/trash/:noteID [method=delete]`: permanently discard a note.\n  \n ## Example screenshots:\n  \n  ### acount route\n ![Screenshot 2022-05-06 190623.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1651914198853/s-_RdqUMz.png)\n \n![Screenshot 2022-05-06 190814.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1651914208965/Zn3Oj8Su7.png)\n### tokens route\n![Screenshot 2022-05-07 090212.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1651914105409/AHhcSmEYX.png)\n\n![Screenshot 2022-05-07 090406.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1651914138626/XHODI7RJH.png)\n\n![Screenshot 2022-05-07 090832.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1651914156762/Uq6iYXnI7.png)\n### notes route\n![Screenshot 2022-05-06 191149.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1651913711402/pkaHPluAl.png)\n![Screenshot 2022-05-06 191408.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1651913728989/DdZNnApdY.png)\n![Screenshot 2022-05-06 235000.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1651913798388/Wq62qA-no.png)\n![Screenshot 2022-05-07 085836.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1651913827851/sBuLRYyhq.png)\n![Screenshot 2022-05-07 085952.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1651913839236/B9ZNWnMPp.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodewithveek%2Fnote-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodewithveek%2Fnote-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodewithveek%2Fnote-api/lists"}