{"id":18577127,"url":"https://github.com/ahmagdy/note-manager","last_synced_at":"2026-04-09T20:45:14.618Z","repository":{"id":144332353,"uuid":"142754877","full_name":"ahmagdy/Note-Manager","owner":"ahmagdy","description":null,"archived":false,"fork":false,"pushed_at":"2018-07-29T11:46:38.000Z","size":31,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-17T15:23:45.371Z","etag":null,"topics":["es6","koa","koajs","mongodb","nodejs"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ahmagdy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2018-07-29T11:22:53.000Z","updated_at":"2018-07-29T20:14:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"bf5a351a-af13-4b63-a947-fcd572a84a3e","html_url":"https://github.com/ahmagdy/Note-Manager","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmagdy%2FNote-Manager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmagdy%2FNote-Manager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmagdy%2FNote-Manager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmagdy%2FNote-Manager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ahmagdy","download_url":"https://codeload.github.com/ahmagdy/Note-Manager/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254448614,"owners_count":22072765,"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":["es6","koa","koajs","mongodb","nodejs"],"created_at":"2024-11-06T23:27:54.868Z","updated_at":"2026-04-09T20:45:14.581Z","avatar_url":"https://github.com/ahmagdy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Note Manager\nIs a simple app to manage notes and it's just a show-case of using [Koa](https://koajs.com/) framework.\n## App parts:\n* Restful API: a couple of endpoints to manage the notes.\n* Job Runner: runs every 5 minutes to check if the scheduled note time comes or not to inform the user.\n\n## How to run:\n* to run the API you can use:\n`npm run start`\n* to run the job runner:\n`npm run job`\n\n### Note Model:\n* content: string, required.\n* attachedFiles: string[].\n* scheduleTime: Date, default current Date.\n* state: number, default 1 and it can be between 1 and 4 . **1** scheduled, **2** reminder sent, **3** seen , **4** done.\n## API endpoints:\n#### /notes, **GET**:\nretrive all notes from server and the expected response will contain array of Note type with 200 status.\nExample:\n```json\n[\n    {\n        \"attachedFiles\": [\n            \"Root\\\\uploads\\\\upload_bcca99b3f163773d888f3d422efbdc38.jpg\"\n        ],\n        \"scheduleTime\": \"2018-07-28T21:17:16.330Z\",\n        \"state\": 1,\n        \"_id\": \"5b5cdd7e77e50847c4b55b85\",\n        \"content\": \"Eat Food\",\n        \"__v\": 0\n    }\n]\n```\n#### /notes, **POST**:\nto post a new note with attached files,\nthe expected input should be like Note Model in addition to attachedFiles of file type, and you should use *form-data* \nexpected output should be like this with 201 status\n```json\n{ \"success\": true }\n```\n\n#### /notes/scheduled, **GET**:\nto get all of the scheduled notes,\nExample:\n```json\n[\n    {\n        \"attachedFiles\": [\n            \"Root\\\\uploads\\\\upload_bcca99b3f163773d888f3d422efbdc38.jpg\"\n        ],\n        \"scheduleTime\": \"2018-07-28T21:17:16.330Z\",\n        \"state\": 1,\n        \"_id\": \"5b5cdd7e77e50847c4b55b85\",\n        \"content\": \"Eat Food\",\n        \"__v\": 0\n    }\n]\n```\n\n#### /notes/search, **GET**:\nto search in the content of all notes, with **content** query string required.\nRequest Example:\n`/notes/search?content= my content`\nand the output will be array of Note.\n\n#### /notes/:id, **GET**:\nto get note details.\nNote will be marked as seen if it contains query param of seen, \nfor example:\n`/nots/1234?seen=1`\nthe state will be tunred to 3\nbut if you requested `/nots/1234` will be without any changes to the note.\n\n#### /notes/:id, **PUT**:\nto update note details and it expects note type as an input.\nand it returns the new version of the note.\n\n#### /notes/:id, **DELETE**:\nto delete single note.\n\n#### /notes/:id/done, **POST**:\nto mark note as done/completed.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmagdy%2Fnote-manager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fahmagdy%2Fnote-manager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmagdy%2Fnote-manager/lists"}