{"id":30269860,"url":"https://github.com/koachcode/shopping-list","last_synced_at":"2025-10-03T19:56:46.825Z","repository":{"id":196546822,"uuid":"696361475","full_name":"koachcode/Shopping-list","owner":"koachcode","description":null,"archived":false,"fork":false,"pushed_at":"2023-10-13T11:13:15.000Z","size":16129,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-16T02:36:48.539Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://shopping-list-opal.vercel.app","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-25T15:36:29.000Z","updated_at":"2023-09-28T18:33:48.000Z","dependencies_parsed_at":"2024-08-22T23:15:32.558Z","dependency_job_id":null,"html_url":"https://github.com/koachcode/Shopping-list","commit_stats":null,"previous_names":["ginohmk/shopping-list","codewithmike01/shopping-list","koachcode/shopping-list"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/koachcode/Shopping-list","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koachcode%2FShopping-list","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koachcode%2FShopping-list/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koachcode%2FShopping-list/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koachcode%2FShopping-list/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/koachcode","download_url":"https://codeload.github.com/koachcode/Shopping-list/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koachcode%2FShopping-list/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278219771,"owners_count":25950350,"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-10-03T02:00:06.070Z","response_time":53,"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-16T02:19:27.688Z","updated_at":"2025-10-03T19:56:46.762Z","avatar_url":"https://github.com/koachcode.png","language":"JavaScript","readme":"# API Development and Documentation Collaboration Project\r\n\r\n## Shopping List App\r\n\r\nThis app is to enable creating and managing shopping lists. The app is developed using Django Rest Framework (DRF).\r\n\r\n### Features\r\n\r\n1. User Registration - User should be able to register with the follwing details:\r\n\r\n- First name\r\n- Last name\r\n- Email\r\n- Password\r\n\r\n2. User login: User can log in with:\r\n\r\n   - Email\r\n   - Password\r\n\r\n3. Email verification: users receives email notification to confirm registered email.\r\n\r\n4. User can perform CRUD operation on the shopping list belonging to them.\r\n\r\n## Starting\r\n\r\n##### Prerequisite\r\n\r\n- Note: You need to have python3.x [installed](https://www.tutorialspoint.com/how-to-install-python-in-windows) on you machine.\r\n\r\n##### Steps\r\n\r\n1.  Clone the project into your machine.\r\n\r\n    ```cmd\r\n          git clone https://github.com/Ginohmk/Shopping-list.git\r\n    ```\r\n\r\n2.  Navigate into the project folder.\r\n\r\n    ```cmd\r\n       cd Shopping-list\r\n    ```\r\n\r\n3.  Start your virtual environment (mac/linux and windows)\r\n\r\n    ```cmd\r\n      source/bin/activate\r\n    ```\r\n\r\n    Or for windows\r\n\r\n    ```cmd\r\n      \\venv\\Scripts\\activate.bat\r\n    ```\r\n\r\n4.  Install project dependencies.\r\n\r\n    ```cmd\r\n      pip install -r requirements.txt\r\n    ```\r\n\r\n5.  Start server\r\n\r\n    ```\r\n      ./manage.py runserver\r\n    ```\r\n\r\n    \u003cbr /\u003e\r\n\r\n### Folder Structure\r\n\r\nThis are the folders and files relevant to this project.\r\n\r\n```\r\n├── shopping_list # Project file\r\n ├── settings.py\r\n ├── urls.py\r\n├── shop # Shopping_list app \u003cbr\u003e\r\n ├── admin.py\r\n ├── models.py\r\n ├── serializers.py\r\n ├── services.py\r\n ├── urls.py\r\n ├── views.py\r\n├── user # User app\r\n ├── admin.py\r\n ├── user_authentications.py # Custom authentication\r\n ├── models.py\r\n ├── user_permissions.py # Custom permision\r\n ├── serializers.py\r\n ├── services.py\r\n ├── urls.py\r\n ├── views.py\r\n├── manage.py\r\n├── README.md\r\n├── requirements.txt\r\n```\r\n\r\n  \u003cbr /\u003e\r\n\r\n### Backend APIs ( Live `https://kanumikec.pythonanywhere.com/` )\r\n\r\n##### User Apis\r\n\r\n1. Registration `/api/users/register/` (Post)\r\n\r\n   - Payload\r\n\r\n   ```json\r\n   {\r\n     \"id\": \"string\",\r\n     \"first_name\": \"string\",\r\n     \"last_name\": \"string\",\r\n     \"email \": \"string\",\r\n     \"password\": \"string\"\r\n   }\r\n   ```\r\n\r\n   - Response 200\r\n\r\n   ```json\r\n   {\r\n     \"id\": \"string\",\r\n     \"first_name\": \"string\",\r\n     \"last_name\": \"string\",\r\n     \"email \": \"string\"\r\n   }\r\n   ```\r\n\r\n   \u003cbr /\u003e\r\n\r\n2. Login `/api/users/login/` (Post)\r\n\r\n   - Payload\r\n\r\n   ```json\r\n   {\r\n     \"email\": \"string\",\r\n     \"password\": \"string\"\r\n   }\r\n   ```\r\n\r\n   - Response 200\r\n     \u003cbr /\u003e\r\n\r\n3. Logout `/api/users/logout/` (Post)\r\n\r\n   - Payload `None`\r\n\r\n   - Response 200\r\n\r\n   ```json\r\n   {\r\n     \"message\": \"Logged out Successfully\"\r\n   }\r\n   ```\r\n\r\n   \u003cbr /\u003e\r\n\r\n4. Me `/api/users/me/` (Get)\r\n\r\n   - Payload `None`\r\n\r\n   - Response 200\r\n\r\n   ```json\r\n   {\r\n     \"id\": \"string\",\r\n     \"first_name\": \"string\",\r\n     \"last_name\": \"string\",\r\n     \"email \": \"string\"\r\n   }\r\n   ```\r\n\r\n  \u003cbr /\u003e\r\n\r\n5. Email verification `/api/user/verify-email/` (Post)\r\n\r\n`Note: Verification link is sent to user and  when clicked they can verify their email`\r\n\r\n- Payload `None`\r\n\r\n- Response 200\r\n\r\n   \u003cbr /\u003e\r\n\r\n##### Shopping_list Apis\r\n\r\n1.  Create shop `/api/shops/` (Post)\r\n\r\n- Payload\r\n\r\n```json\r\n{\r\n \"description\": \"string\",\r\n \"priority\": int,\r\n \"title\": \"string\",\r\n \"due_date\": \"string datetime\",\r\n \"quantity\": int,\r\n \"is_complete\": boolean\r\n}\r\n```\r\n\r\n- Response 200\r\n\r\n```json\r\n{\r\n \"id\": \"uuid string\",\r\n \"description\": \"string\",\r\n \"priority\": int,\r\n \"title\": \"string\",\r\n \"due_date\": \"string datetime\",\r\n \"quantity\": int,\r\n \"is_complete\": boolean\r\n \"user\": {\r\n   \"id\": \"string\",\r\n   \"first_name\": \"string\",\r\n   \"last_name\": \"string\",\r\n   \"email\": \"string\"\r\n }\r\n}\r\n```\r\n\r\n  \u003cbr /\u003e\r\n\r\n2. Get All shop `/api/shops/` (Get)\r\n\r\n   - Response 200\r\n\r\n   ```json\r\n    [\r\n      {\r\n        \"id\": \"uuid string\",\r\n        \"description\": \"string\",\r\n        \"priority\": int,\r\n        \"title\": \"string\",\r\n        \"due_date\": \"string datetime\",\r\n        \"quantity\": int,\r\n        \"is_complete\": boolean\r\n        \"user\": {\r\n          \"id\": \"string\",\r\n          \"first_name\": \"string\",\r\n          \"last_name\": \"string\",\r\n          \"email\": \"string\"\r\n        }\r\n      }\r\n    ]\r\n   ```\r\n\r\n     \u003cbr /\u003e\r\n\r\n3. Delete shop `/api/shops/\u003cid: str\u003e/` (Delete)\r\n\r\n   - Response 204\r\n     \u003cbr /\u003e\r\n\r\n4. Update shop `/api/shops/\u003cid: str\u003e/` (Put)\r\n\r\n- Payload\r\n\r\n  ```json\r\n  {\r\n  \"description\": \"string\",\r\n  \"priority\": int,\r\n  \"title\": \"string\",\r\n  \"due_date\": \"string datetime\",\r\n  \"quantity\": int,\r\n  \"is_complete\": boolean\r\n  }\r\n  ```\r\n\r\n- Response 200\r\n\r\n```json\r\n   {\r\n     \"id\": \"uuid string\",\r\n     \"description\": \"string\",\r\n     \"priority\": int,\r\n     \"title\": \"string\",\r\n     \"due_date\": \"string datetime\",\r\n     \"quantity\": int,\r\n     \"is_complete\": boolean\r\n     \"user\": {\r\n       \"id\": \"string\",\r\n       \"first_name\": \"string\",\r\n       \"last_name\": \"string\",\r\n       \"email\": \"string\"\r\n     }\r\n   }\r\n```\r\n\r\n5. Retreive sinfle shop `/api/shops/\u003cid: str\u003e/` (Get)\r\n\r\n- Response 200\r\n\r\n```json\r\n   {\r\n     \"id\": \"uuid string\",\r\n     \"description\": \"string\",\r\n     \"priority\": int,\r\n     \"title\": \"string\",\r\n     \"due_date\": \"string datetime\",\r\n     \"quantity\": int,\r\n     \"is_complete\": boolean\r\n     \"user\": {\r\n       \"id\": \"string\",\r\n       \"first_name\": \"string\",\r\n       \"last_name\": \"string\",\r\n       \"email\": \"string\"\r\n     }\r\n   }\r\n```\r\n\r\n\u003cbr/\u003e\r\n### Author\r\n\r\n👤 **Kanu Mike**\r\n\r\n- GitHub: [@Ginohmk](https://github.com/Ginohmk)\r\n- Twitter: [@michotall95](https://www.twitter.com/michotall95)\r\n- LinkedIn: [@kanumike](https://www.linkedin.com/in/mike-kanu-dev/)\r\n- Instagram: [@savy_kanu_mike](https/instagram.com/savy_kanu_mike)\r\n- Facebook: [@mike.kanu](https://www.facebook.com/mike.kanu)\r\n\r\n👤 **Evan Guma**\r\n\r\n- GitHub: [@ayera-4](https://github.com/ayera-4)\r\n\r\n### 🤝 Contribute\r\n\r\nContributions, issues, and feature requests are welcome!\r\n\r\nFeel free to check the [issues page](https://github.com/Ginohmk/online-note-book-drf/issues)\r\n\r\n### Acknowledgement\r\n\r\n## Show your support\r\n\r\nGive a ⭐️ if you like this project!\r\n\r\n## 📝 License\r\n\r\nThis project is [MIT](./MIT.md) licensed.\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoachcode%2Fshopping-list","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkoachcode%2Fshopping-list","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoachcode%2Fshopping-list/lists"}