{"id":20489868,"url":"https://github.com/tomilola-ng/trackbackendtask2","last_synced_at":"2026-04-10T17:02:49.370Z","repository":{"id":194381040,"uuid":"690223797","full_name":"Tomilola-ng/TrackBackendTask2","owner":"Tomilola-ng","description":"A CRUD REST API for a Person model using Django, Django Rest Framework, CORS Headers ...","archived":false,"fork":false,"pushed_at":"2023-09-12T21:52:01.000Z","size":161,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-16T05:14:41.879Z","etag":null,"topics":["cors-headers","crud","django","django-rest-framework","postgresql","python"],"latest_commit_sha":null,"homepage":"https://hngx-backend-track-task2.onrender.com/api/","language":"Python","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/Tomilola-ng.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}},"created_at":"2023-09-11T19:21:20.000Z","updated_at":"2024-05-10T17:52:40.000Z","dependencies_parsed_at":"2023-09-13T04:23:32.699Z","dependency_job_id":null,"html_url":"https://github.com/Tomilola-ng/TrackBackendTask2","commit_stats":null,"previous_names":["tomilola-ng/trackbackendtask2"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tomilola-ng%2FTrackBackendTask2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tomilola-ng%2FTrackBackendTask2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tomilola-ng%2FTrackBackendTask2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tomilola-ng%2FTrackBackendTask2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tomilola-ng","download_url":"https://codeload.github.com/Tomilola-ng/TrackBackendTask2/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242067714,"owners_count":20066751,"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":["cors-headers","crud","django","django-rest-framework","postgresql","python"],"created_at":"2024-11-15T17:14:33.351Z","updated_at":"2025-12-30T22:52:12.716Z","avatar_url":"https://github.com/Tomilola-ng.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HNGx CRUD Person REST API\nThis is a Django REST API project that allows you to manage and interact with a \"Person\"\nresource. You can perform CRUD (Create, Read, Update, Delete) operations on individuals'\ndata.\n## Table of Contents\n- [Getting Started](#getting-started)\n- [Prerequisites](#prerequisites)\n- [Installation](#installation)\n- [Usage](#usage)\n- [API Endpoints](#api-endpoints)\n- [Testing](#testing)\n- [Deployment](#deployment)\n- [Documentation](#documentation)\n- [Contributing](#contributing)\n- [License](#license)\n## Getting Started\n![UML Diagram for the CRUD Person REST API](./UML.png)\n### Prerequisites\n- [Python](https://www.python.org/downloads/) (3.10 or higher)\n- [Django](https://www.djangoproject.com/) (3.0 or higher)\n- [Django Rest Framework](https://www.django-rest-framework.org/)\n- [Git](https://git-scm.com/)\n### Installation\n1. Clone the repository:\n```bash\ngit clone https://github.com/Tomilola-ng/TrackBackendTask2.git\ncd my-awesome-api\n```\n2. Create and activate a virtual environment:\n```bash\npython -m venv venv\nsource venv/bin/activate\n```\n3. Install dependencies:\n```bash\npip install -r requirements.txt\n```\n4. Apply database migrations:\n```bash\npython manage.py migrate\n```\n5. Start the development server:\n```bash\npython manage.py runserver\n```\nYour API should now be running locally at `http://localhost:8000/`.\n## Usage\nTo use the API, you can make HTTP requests to the provided endpoints. Here's an overview of\nthe available endpoints:\n## API Endpoints\n- `POST /api`: Create a new person.\n- `GET /api/\u003cuser_id\u003e`: Retrieve details of a person by their ID.\n- `PUT /api/\u003cuser_id\u003e`: Update details of an existing person.\n- `DELETE /api/\u003cuser_id\u003e`: Remove a person.\n### Example Requests\n- Create a new person:\n```http\nPOST http://localhost:8000/api\nContent-Type: application/json\n{\n\"name\": \"John Doe\",\n\"email\": \"john@example.com\"\n}\n```\n- Retrieve details of a person:\n```http\nGET http://localhost:8000/api/1\n```\n- Update details of a person:\n```http\nPUT http://localhost:8000/api/1\nContent-Type: application/json\n{\n\"name\": \"Updated John Doe\",\n\"email\": \"updated_john@example.com\"\n}\n```\n- Remove a person:\n```http\nDELETE http://localhost:8000/api/1\n```\n## Testing\nTo run the test suite, use the following command:\n```bash\npython manage.py test\n```\n\n## Documentation\nFor detailed information on how to use this API, check the [API Documentation](DOCUMENTATION.md) file.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomilola-ng%2Ftrackbackendtask2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftomilola-ng%2Ftrackbackendtask2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomilola-ng%2Ftrackbackendtask2/lists"}