{"id":15180592,"url":"https://github.com/alexander784/recipe_api","last_synced_at":"2026-03-07T02:34:18.756Z","repository":{"id":255008436,"uuid":"848200975","full_name":"alexander784/Recipe_API","owner":"alexander784","description":"A RESTful API developed on Django,the API allows users to manage recipes by executing CRUD","archived":false,"fork":false,"pushed_at":"2024-08-27T12:30:12.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-31T23:04:44.488Z","etag":null,"topics":["api","django","django-application","django-rest-framework","sqlite"],"latest_commit_sha":null,"homepage":"","language":"Python","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/alexander784.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-27T10:21:18.000Z","updated_at":"2024-08-27T12:30:17.000Z","dependencies_parsed_at":"2024-08-27T13:38:31.606Z","dependency_job_id":"f2edbf89-e4e0-467a-a46c-007fb0614538","html_url":"https://github.com/alexander784/Recipe_API","commit_stats":null,"previous_names":["alexander784/recipe_api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexander784%2FRecipe_API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexander784%2FRecipe_API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexander784%2FRecipe_API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexander784%2FRecipe_API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alexander784","download_url":"https://codeload.github.com/alexander784/Recipe_API/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238394323,"owners_count":19464583,"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":["api","django","django-application","django-rest-framework","sqlite"],"created_at":"2024-09-27T16:23:12.493Z","updated_at":"2025-10-26T19:31:50.518Z","avatar_url":"https://github.com/alexander784.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Recipe API\nIntroduction\n\u003cp\u003e This is a RESTful API developed on Django, a strong Python web framework, with SQlite as the database backend. The API allows users to manage recipes by executing CRUD (Create, Read, Update, and Delete) activities on them. Each recipe contains a title and a description.\u003c/p\u003e\n\n## Features\n\nCreate a new recipe  with title and description. \u003cbr\u003e\nRetrieve a list of all recipes.\u003cbr\u003e\nRetrieve details of a specific recipe by its ID.\u003cbr\u003e\nUpdate an existing recipe  title and/or description.\u003cbr\u003e\nDelete recipe by its ID.\u003cbr\u003e\n\n## Technologies Used:\n\n** Django: A high-level web framework written in Python\u003cbr\u003e\n** Django REST framework: A powerful and flexible toolkit for building Web APIs in Django.\u003cbr\u003e\nPython: The programming language used for backend development.\u003cbr\u003e\nGit: Version control system for tracking changes in source code.\u003cbr\u003e\n\n## Setup and Installation \n\u003cp\u003eTo run the recipe API locally on your machine, follow these steps:\u003c/p\u003e\n1. Ensure you have Python and pip installed. If not, refer to the prerequisites in the documentation.\u003cbr\u003e\n2. Clone this repository to your local machine:\u003cbr\u003e\n\n git clone `https://github.com/alexander784/Recipe_API.git`\u003cbr\u003e\n3. \u003cp\u003eCreate and activate a virtual environment:\u003c/p\u003e\n  `python -m venv env`\u003cbr\u003e\n`# On Windows:`\u003cbr\u003e\n`. env/Scripts/activate`\u003cbr\u003e\n`# On macOS/Linux:`\u003cbr\u003e\n`source env/bin/activate`\u003cbr\u003e\n\n4. Install the required dependencies:\u003cbr\u003e\n   `pip install -r requirements.txt`\u003cbr\u003e\n\n5. Confirm SQlite database configurations:\u003cbr\u003e\n`DATABASES = {`\u003cbr\u003e\n    `'default': {`\u003cbr\u003e\n        `'ENGINE': 'django.db.backends.``sqlite3',`\u003cbr\u003e\n        `'NAME': BASE_DIR / 'db.``sqlite3',`\u003cbr\u003e\n    `}`\u003cbr\u003e\n`}`\u003cbr\u003e\n\n1. Apply database migrations:\u003cbr\u003e\n`python3 manage.py makemigrations`\u003cbr\u003e\n`python3 manage.py migrate`\n\n2. Run the development server:\u003cbr\u003e\n`python3 manage.py runserver`\n\n\u003cp\u003eThe API should be accessible at: http://127.0.0.1:8000/recipe_app/\u003c/p\u003e\n\n# API End points\n\u003cp\u003e The following are the Recipe API Endpoints:\u003c/p\u003e\n\n\n## Request and Response Format\n\u003cp\u003eThe API accepts and returns data in JSON format.\u003c/p\u003e \u003cbr\u003e\n\n`{`\u003cbr\u003e\n    `\"title\": \"recipe title\",`\u003cbr\u003e\n    `\"description\": \"Describe the recipe.\"`\u003cbr\u003e\n`}`\n\n\u003cp\u003eResponse format (GET and POST):\u003c/p\u003e \u003cbr\u003e\n\n`{`\u003cbr\u003e\n    `\"id\": 1,`\u003cbr\u003e\n    `\"name\": \"recipe title\",`\u003cbr\u003e\n    `\"description\": \"Description of the recipe.\"`\u003cbr\u003e\n`}`\u003cbr\u003e\n\n## API Usage:\n1. Get list of all recipes: \u003cbr\u003e\n`GET http://127.0.0.1:8000/recipe_app/`\n\n2. Create new recipe \u003cbr\u003e\n\n`POST http://127.0.0.1:8000/recipe_app/`\u003cbr\u003e\n`{`\u003cbr\u003e\n    `\"title\": \"Pilau\",`\u003cbr\u003e\n    `\"description\": \"Boil water for about ten minutes.\"`\u003cbr\u003e\n`}`\n\n3. Get details of a specific recipe by ID:\u003cbr\u003e\n`GET http://127.0.0.1:8000/recipe_app/1/` \n\n4. Update an existing recipe by ID:\u003cbr\u003e\n\n`PUT http://127.0.0.1:8000/recipe_app/1/`\u003cbr\u003e\n`{`\u003cbr\u003e\n    `\"name\": \"Pilau masala\",`\u003cbr\u003e\n    `\"description\": \"Pilau spices\"`\u003cbr\u003e\n`}`\u003cbr\u003e\n\n5. Delete a recipe by ID:\u003cbr\u003e\n`DELETE http://127.0.0.1:8000/recipe_app/1/`\n\n## \u003cp\u003e Author: Alexander Nyaga.\u003c/p\u003e\n\n## License \nThis project is licensed under MIT License.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexander784%2Frecipe_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexander784%2Frecipe_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexander784%2Frecipe_api/lists"}