{"id":29968176,"url":"https://github.com/koachcode/online-note-book-drf","last_synced_at":"2025-09-10T16:36:34.916Z","repository":{"id":196095312,"uuid":"694330063","full_name":"koachcode/online-note-book-drf","owner":"koachcode","description":null,"archived":false,"fork":false,"pushed_at":"2023-11-08T07:22:12.000Z","size":16279,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-11T02:13:24.037Z","etag":null,"topics":[],"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/koachcode.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":"2023-09-20T19:28:30.000Z","updated_at":"2023-10-21T06:15:42.000Z","dependencies_parsed_at":"2024-08-22T23:15:41.866Z","dependency_job_id":null,"html_url":"https://github.com/koachcode/online-note-book-drf","commit_stats":null,"previous_names":["ginohmk/online-note-book-drf","codewithmike01/online-note-book-drf","koachcode/online-note-book-drf"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/koachcode/online-note-book-drf","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koachcode%2Fonline-note-book-drf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koachcode%2Fonline-note-book-drf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koachcode%2Fonline-note-book-drf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koachcode%2Fonline-note-book-drf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/koachcode","download_url":"https://codeload.github.com/koachcode/online-note-book-drf/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koachcode%2Fonline-note-book-drf/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268644980,"owners_count":24283408,"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","status":"online","status_checked_at":"2025-08-04T02:00:09.867Z","response_time":79,"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":"2025-08-04T03:37:27.126Z","updated_at":"2025-08-04T03:37:27.952Z","avatar_url":"https://github.com/koachcode.png","language":"JavaScript","readme":"# API Development and Documentation Tunga Accessment\n\n## Online Note App\n\nThe online Notes is be use by staff to log thier personal notes. The online note app is developed using Django Rest Framework (DRF).\n\nhttps://github.com/Ginohmk/online-note-book-drf/assets/58771507/3b1a8781-2fa2-4ddf-9a96-427772144469\n\n### Live link\n\nHosted on aws, [live link](http://44.241.249.189:8000/api/schema/docs/) to swagger doc\n\n#### Test passed ( used pytest)\n\n![image](https://github.com/Ginohmk/online-note-book-drf/assets/58771507/d2aa578b-0069-4b35-8420-7c44a77cc980)\n\n### Features\n\n1. User Registration - User should be able to register with the follwing details:\n\n- First name\n- Last name\n- Email\n- Password\n\n2. User login: User can log in with:\n\n   - Email\n   - Password\n\n3. Password recovery: users can recovery password when forgotton, by updating/reseting password using `Email link`.\n\n4. User can perform CRUD operation on Dairy notes beloging to them.\n\n5. User can order notes based on lastest\n\n6. User can filter notes based on:\n\n   - Unfinished\n   - Overdute notes\n   - Done notes\n\n7. Sort all note by:\n\n   - Due date\n   - Priority\n   - Created-time\n\n8. Export notes list to pdf and csv\n\n9. Share or publish the notes over an email\n\n10. Set email reminder for notes\n\n## Starting\n\n##### Prerequisite\n\n- Note: You need to have python3.x [installed](https://www.tutorialspoint.com/how-to-install-python-in-windows) on you machine.\n\n##### Steps\n\n1.  Clone the project into your machine.\n\n    ```cmd\n          git clone https://github.com/Ginohmk/online-note-book-drf.git\n    ```\n\n2.  Navigate into the project folder.\n\n    ```cmd\n       cd online-note-book-drf\n    ```\n\n3.  Start your virtual environment (mac/linux and windows)\n\n    ```cmd\n      source/bin/activate\n    ```\n\n    Or for windows\n\n    ```cmd\n      \\venv\\Scripts\\activate.bat\n    ```\n\n4.  Install project dependencies.\n\n    ```cmd\n      pip install -r requirements.txt\n    ```\n\n5.  Start server\n\n    ```\n      ./manage.py runserver\n    ```\n\n    \u003cbr /\u003e\n\n###### Alternative startup\n\nThey is a build.sh script that can be used to setup and run the project for you, following the steps below\n\n1.  Clone the project into your machine.\n\n    ```cmd\n          git clone https://github.com/Ginohmk/online-note-book-drf.git\n    ```\n\n2.  Navigate into the project folder.\n\n    ```cmd\n       cd online-note-book-drf\n    ```\n\n3.  Start your virtual environment (mac/linux and windows)\n\n    ```cmd\n      source/bin/activate\n    ```\n\n    Or for windows\n\n    ```cmd\n      \\venv\\Scripts\\activate.bat\n    ```\n\n4.  Make build.sh executable\n\n```cmd\nchmod +x build.sh\n```\n\n5. Run the excutable script\n\n```cmd\n./build.sh\n```\n\n\u003cbr /\u003e\n\n##### Key Note\n\nThis application may not work as it should on your local machine, Due to the fact that it is missing some environment variables, This variable are private to a user and as such i have created a spot for you to input yours by editing the `Enter yours` found in settings.py. You can it on the following:\n\n- SECRET_KEY\n- JWT_KEY\n- EMAIL_HOST_USER : For this you can use your personal email address(G-mail).\n- EMAIL_HOST_PASSWORD: For this you can use you email(G-mail) [App Password](https://support.google.com/mail/answer/185833?hl=en#:~:text=Under%20%22Signing%20in%20to%20Google,Select%20Generate.)\n\n\u003cbr /\u003e\n\n### Folder Structure\n\nThis are the folders and files relevant to this project.\n\n```doc\n├── drf # Project file\n  ├── settings.py\n  ├── urls.py\n├── note # Note app \u003cbr\u003e\n  ├── admin.py\n  ├── models.py\n  ├── serializers.py\n  ├── services.py\n  ├── urls.py\n  ├── views.py\n├── users # User app\n  ├── admin.py\n  ├── authentication.py # Custom authentication\n  ├── models.py\n  ├── permission.py # Custom permision\n  ├── serializers.py\n  ├── services.py\n  ├── urls.py\n  ├── views.py\n├── build.sh\n├── manage.py\n├── README.md\n├── requirements.txt\n```\n\n  \u003cbr /\u003e\n\n### Backend APIs\n\n##### Swagger Docs\n\n`/api/schema/docs/`\n\n##### User Apis\n\n1. Registration `/api/users/register/` (Post)\n\n   - Payload\n\n   ```json\n   {\n     \"id\": \"string\",\n     \"first_name\": \"string\",\n     \"last_name\": \"string\",\n     \"email \": \"string\",\n     \"password\": \"string\",\n     \"is_email_verified\": boolean\n   }\n   ```\n\n   - Response 200\n\n   ```json\n   {\n     \"id\": \"string\",\n     \"first_name\": \"string\",\n     \"last_name\": \"string\",\n     \"email \": \"string\",\n     \"is_email_verified\": false\n   }\n   ```\n\n   \u003cbr /\u003e\n\n2. Login `/api/users/login/` (Post)\n\n   - Payload\n\n   ```json\n   {\n     \"email\": \"string\",\n     \"password\": \"string\"\n   }\n   ```\n\n   - Response 200\n     \u003cbr /\u003e\n\n3. Logout `/api/users/logout/` (Post)\n\n   - Payload `None`\n\n   - Response 200\n\n   ```json\n   {\n     \"message\": \"Logged out Successfully\"\n   }\n   ```\n\n   \u003cbr /\u003e\n\n4. Me `/api/users/me/` (Get)\n\n   - Payload `None`\n\n   - Response 200\n\n   ```json\n   {\n     \"id\": \"string\",\n     \"first_name\": \"string\",\n     \"last_name\": \"string\",\n     \"email \": \"string\",\n     \"is_email_verified\": boolean\n   }\n   ```\n\n  \u003cbr /\u003e\n\n5. Email verification `/api/users/verify-email/` (Post)\n\n`Note: Verification link is sent to user and  when clicked they can verify thier email`\n\n- Payload `None`\n\n- Response 200\n\n   \u003cbr /\u003e\n\n5. Request password reset link `/api/users/request-password-reset/` (Post)\n\n`Note: Passsword Reset link is sent to user`\n\n- Payload `None`\n\n- Response 200\n  \u003cbr /\u003e\n\n5. Confirm and reset password `/api/users/reset_password_confirm/\u003cuidb64\u003e/\u003ctoken\u003e/` (Post)\n\n`Note: Passsword Reset link is sent to user`\n\n- Payload\n\n```json\n{\n  \"token\": \"string\",\n  \"uidb64\": \"string\",\n  \"password\": \"string\"\n}\n```\n\n- Response 200\n\n```json\n {\n     \"id\": \"string\",\n     \"first_name\": \"string\",\n     \"last_name\": \"string\",\n     \"email \": \"string\",\n     \"is_email_verified\": boolean\n   }\n```\n\n   \u003cbr /\u003e\n\n##### Note Apis\n\n1.  Create note `/api/notes/create/` (Post)\n\n`Note: priority accepts min = 1 and max = 10`\n\n- Payload\n\n```json\n{\n \"title\": \"string\",\n \"content\": \"string\",\n \"due_date\": \"string datetime\",\n \"is_complete\": boolean,\n \"priority\": int\n}\n```\n\n- Response 200\n\n```json\n{\n \"id\": \"uuid string\",\n \"title\": \"string\",\n \"content\": \"string\",\n \"created_at\": null,\n \"due_date\": \"string datetime\",\n \"priority\": int,\n \"is_complete\": boolean,\n \"user\": {\n   \"id\": \"string\",\n   \"first_name\": \"string\",\n   \"last_name\": \"string\",\n   \"email\": \"string\"\n }\n}\n```\n\n  \u003cbr /\u003e\n\n2. Get user notes `/api/notes/create/` (Get)\n\n   - Response 200\n\n   ```json\n    [\n      {\n        \"id\": \"uuid string\",\n        \"title\": \"string\",\n        \"content\": \"string\",\n        \"created_at\": null,\n        \"due_date\": \"string datetime\",\n        \"priority\": int,\n        \"is_complete\": boolean,\n        \"user\": {\n          \"id\": \"string\",\n          \"first_name\": \"string\",\n          \"last_name\": \"string\",\n          \"email\": \"string\"\n        }\n      }\n    ]\n   ```\n\n     \u003cbr /\u003e\n\n3. Get all notes `/api/notes/` (Get)\n\n   - Response 200\n\n   ```json\n    [\n      {\n        \"id\": \"uuid string\",\n        \"title\": \"string\",\n        \"content\": \"string\",\n        \"created_at\": null,\n        \"due_date\": \"string datetime\",\n        \"priority\": int,\n        \"is_complete\": boolean,\n        \"user\": {\n          \"id\": \"string\",\n          \"first_name\": \"string\",\n          \"last_name\": \"string\",\n          \"email\": \"string\"\n        }\n      }\n    ]\n   ```\n\n4. Delete note `/api/notes/\u003cid: str\u003e/` (Delete)\n\n   - Response 204\n     \u003cbr /\u003e\n\n5. Update note `/api/notes/\u003cid: str\u003e/` (Put)\n\n- Payload\n\n  ```json\n  {\n  \"title\": \"string\",\n  \"content\": \"string\",\n  \"due_date\": \"string datetime\",\n  \"is_complete\": boolean,\n  \"priority\": int\n  }\n  ```\n\n- Response 200\n\n```json\n   {\n     \"id\": \"uuid string\",\n     \"title\": \"string\",\n     \"content\": \"string\",\n     \"created_at\": null,\n     \"due_date\": \"string datetime\",\n     \"priority\": int,\n     \"is_complete\": boolean,\n     \"user\": {\n       \"id\": \"string\",\n       \"first_name\": \"string\",\n       \"last_name\": \"string\",\n       \"email\": \"string\"\n     }\n   }\n```\n\n5. Retreive note `/api/notes/\u003cid: str\u003e/` (Get)\n\n- Response 200\n\n```json\n   {\n     \"id\": \"uuid string\",\n     \"title\": \"string\",\n     \"content\": \"string\",\n     \"created_at\": null,\n     \"due_date\": \"string datetime\",\n     \"priority\": int,\n     \"is_complete\": boolean,\n     \"user\": {\n       \"id\": \"string\",\n       \"first_name\": \"string\",\n       \"last_name\": \"string\",\n       \"email\": \"string\"\n     }\n   }\n```\n\n\u003cbr/\u003e\n\n### Author\n\n👤 **Kanu Mike**\n\n- GitHub: [@Ginohmk](https://github.com/Ginohmk)\n- Twitter: [@michotall95](https://www.twitter.com/michotall95)\n- LinkedIn: [@kanumike](https://www.linkedin.com/in/mike-kanu-dev/)\n- Instagram: [@savy_kanu_mike](https/instagram.com/savy_kanu_mike)\n- Facebook: [@mike.kanu](https://www.facebook.com/mike.kanu)\n\n### 🤝 Contribute\n\nContributions, issues, and feature requests are welcome!\n\nFeel free to check the [issues page](https://github.com/Ginohmk/online-note-book-drf/issues)\n\n### Acknowledgement\n\nI want to acknowledge Tunga Impact Academy, for thier support, training and for time taken to nuture and improve my backend skill as a Django Rest Framework Developer.\n\n## Show your support\n\nGive a ⭐️ if you like this project!\n\n## 📝 License\n\nThis project is [MIT](./MIT.md) licensed.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoachcode%2Fonline-note-book-drf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkoachcode%2Fonline-note-book-drf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoachcode%2Fonline-note-book-drf/lists"}