{"id":17026950,"url":"https://github.com/shashwatah/denote","last_synced_at":"2025-04-12T11:51:03.753Z","repository":{"id":117209886,"uuid":"267354361","full_name":"shashwatah/denote","owner":"shashwatah","description":"REST API with JWT authentication for a generic notes app built with Deno, and Oak.","archived":false,"fork":false,"pushed_at":"2024-01-10T19:15:29.000Z","size":37,"stargazers_count":11,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-26T06:34:32.382Z","etag":null,"topics":["authentication","crud","crud-application","deno","denon","generic","jsonwebtokens","jwt","notes","notes-app","oak","rest","rest-api","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/shashwatah.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}},"created_at":"2020-05-27T15:18:57.000Z","updated_at":"2025-02-06T17:21:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"126de3f4-70c0-4da7-a673-51a62d578332","html_url":"https://github.com/shashwatah/denote","commit_stats":null,"previous_names":["shashwatah/denote"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shashwatah%2Fdenote","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shashwatah%2Fdenote/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shashwatah%2Fdenote/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shashwatah%2Fdenote/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shashwatah","download_url":"https://codeload.github.com/shashwatah/denote/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248564986,"owners_count":21125412,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["authentication","crud","crud-application","deno","denon","generic","jsonwebtokens","jwt","notes","notes-app","oak","rest","rest-api","typescript"],"created_at":"2024-10-14T07:45:22.455Z","updated_at":"2025-04-12T11:51:03.731Z","avatar_url":"https://github.com/shashwatah.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Denote\n\n\u003ch4\u003eREST API with JWT authentication for a generic notes app built with \u003ca href=\"https://deno.land/\"\u003eDeno\u003c/a\u003e (v1.4.0), \u003ca href=\"https://github.com/oakserver/oak\"\u003eOak\u003c/a\u003e, and \u003ca href=\"https://www.typescriptlang.org/\"\u003eTypeScript\u003c/a\u003e.\u003c/h4\u003e\n\n\u003ca href=\"https://github.com/shashwatah/denote/blob/main/LICENSE\"\u003e\u003cimg alt=\"MIT License\" src=\"https://img.shields.io/badge/license-MIT-green\"\u003e\u003c/a\u003e\n\n## Instructions\n\nFollow the standard procedure to clone the repository and then continue with the steps.\n\nDenote uses ***denon*** as a nodemon alternative for deno. After installing run the following command to install denon. \n\n```bash\n$ deno install --allow-read --allow-run --allow-write --allow-net -f -q --unstable https://deno.land/x/denon@2.4.0/denon.ts\n```\n\n\u003e It will use the config specified in ***denon.json***.\n\nRun Denote with the following command:\n\n```bash\n$ denon start\n```\n\nIf denon doesn't work (or if you don't want to monitor file changes) use the following command:\n\n```bash\n$ deno run --allow-net --allow-read server.ts\n```\n\n\u003e Denote reads the port it is supposed to run on from the '.env' file. The default port is 108. \n\n## Important information \n\n### API Endpoints\n\n```\nGET     /token                  # =\u003e Get auth token\nGET     /api/users              # =\u003e Get all the users\nPOST    /api/users              # =\u003e Add a user\nGET     /api/users/:id          # =\u003e Get one particular user\nGET     /api/users/:id/notes    # =\u003e Get one user's notes\nDELETE  /api/users/:id          # =\u003e Delete a user\nGET     /api/notes              # =\u003e Get all the notes\nGET     /api/notes/:id          # =\u003e Get one particular note\nPOST    /api/notes              # =\u003e Add a note\nPUT     /api/notes/:id          # =\u003e Update a note\nDELETE  /api/notes/:id          # =\u003e Delete a note\n```\n\n### Default user creds \n\n```\nusername: admin\npassword: admin\n```\n\n### Accessing the API \n\nTo get started send a request to /token with the default username and password in the body to get the auth token. That token is required to be sent with every request to any other endpoint as the 'Authorization' header.\n\n## Update checklist\n\n| Status |         Update         | \n|--------|:----------------------:|\n|   ✅   |   JWT Authentication   |\n|        |     NoSQL Database     | ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshashwatah%2Fdenote","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshashwatah%2Fdenote","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshashwatah%2Fdenote/lists"}