{"id":28829899,"url":"https://github.com/hadijahkyampeire/newyummy_api","last_synced_at":"2026-04-29T19:33:05.242Z","repository":{"id":27427002,"uuid":"111545549","full_name":"hadijahkyampeire/newyummy_api","owner":"hadijahkyampeire","description":"This is a yummy recipes Api which allows users to create and manipulate food Recipes","archived":false,"fork":false,"pushed_at":"2022-12-07T23:42:32.000Z","size":240,"stargazers_count":1,"open_issues_count":10,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-06-19T05:18:35.710Z","etag":null,"topics":["flask-api","nosetests","postgresql","python3","sqlalchemy"],"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/hadijahkyampeire.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"License.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-21T12:22:00.000Z","updated_at":"2019-10-21T17:50:38.000Z","dependencies_parsed_at":"2022-07-27T09:32:14.316Z","dependency_job_id":null,"html_url":"https://github.com/hadijahkyampeire/newyummy_api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hadijahkyampeire/newyummy_api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hadijahkyampeire%2Fnewyummy_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hadijahkyampeire%2Fnewyummy_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hadijahkyampeire%2Fnewyummy_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hadijahkyampeire%2Fnewyummy_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hadijahkyampeire","download_url":"https://codeload.github.com/hadijahkyampeire/newyummy_api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hadijahkyampeire%2Fnewyummy_api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32441089,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-29T18:12:22.909Z","status":"ssl_error","status_checked_at":"2026-04-29T18:11:33.322Z","response_time":110,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["flask-api","nosetests","postgresql","python3","sqlalchemy"],"created_at":"2025-06-19T05:15:37.589Z","updated_at":"2026-04-29T19:33:05.236Z","avatar_url":"https://github.com/hadijahkyampeire.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n[![Build Status](https://travis-ci.org/hadijahkyampeire/newyummy_api.svg?branch=api)](https://travis-ci.org/hadijahkyampeire/newyummy_api)\n[![Coverage Status](https://coveralls.io/repos/github/hadijahkyampeire/newyummy_api/badge.svg?branch=master)](https://coveralls.io/github/hadijahkyampeire/newyummy_api?branch=master)\n[![Maintainability](https://api.codeclimate.com/v1/badges/930b41f7e96ab8f63f98/maintainability)](https://codeclimate.com/github/hadijahkyampeire/newyummy_api/maintainability)\n\u003ca href=\"https://www.python.org/dev/peps/pep-0008/\"\u003e\n\u003cimg class=\"notice-badge\" src=\"https://img.shields.io/badge/code%20style-pep8-orange.svg\" alt=\"Badge\"/\u003e\n\u003c/a\u003e\n\u003ca href=\"https://github.com/hadijahkyampeire/newyummy_api/blob/api/License.md\"\u003e\n\u003cimg class=\"notice-badge\" src=\"https://img.shields.io/badge/License-MIT-yellow.svg\" alt=\"Badge\"/\u003e\n\u003c/a\u003e\n# yummyrecipes_api\n# Description\nyummyrecipes_api is a RESTFul web api that let's users create accounts, login and create, view, edit and delete categories and recipes.\n# API-Documentation\n*see the API Documentation by following this [url](http://127.0.0.1:5000/apidocs/#/)*\n# Demo\nThe API demo is deployed on heroku at https://hadijahyummyrecipe-api.herokuapp.com/apidocs/#/\n\n## Requirements(Building Blocks)\n- `Python3` - A programming language that lets us work more quickly (The universe loves speed!).\n- `Flask` - A microframework for Python based on Werkzeug, Jinja 2 and good intentions\n- `Virtualenv` - A tool to create isolated virtual environment\n- `PostgreSQL` – Postgres database offers many advantages over others.\n- `Psycopg2` – A Python adapter for Postgres.\n- `Flask-SQLAlchemy` – A Flask extension that provides support for SQLAlchemy.\n- `Flask-Migrate` – Offers SQLAlchemy database migrations for Flask apps using Alembic.\n\n## Installation\nFirst clone this repository\n```\n$ git clone @https://github.com/hadijahkyampeire/newyummy_api\n$ cd Yummy-Recipe-RestAPI\n```\nCreate virtual environment and install it\n```\n$ virtualenv --python=python3 venv\n$ source /venv/bin/activate\n```\nThen install all the necessary dependencies by\n```\npip install -r requirements.txt\n```\n\n## Set environment varibles and setup database\n### On windows\nYou need to create a test database for tests to run\npostgres# CREATE DATABASE test_db\nAt the terminal or console type\n```\nset APP_SETTINGS=development\nset DATABASE_URL_DEV=postgresql://postgres:@localhost/flask_api\npsql -U postgres\npostgres# CREATE DATABASE yummy_api\n```\n### On linux/Ubuntu or Mac\nAt the terminal or console type\n```\nexport APP_SETTINGS=development\nexport DATABASE_URL=postgresql://postgres:@localhost/flask_api\npsql -U postgres\npostgres# CREATE ROLE postgres\npostgres# CREATE DATABASE flask_api\n```\n\n## Initialize the database and create database tables\n```\n$ python manage.py db init\n$ python manage.py db migrate\n$ python manage.py db upgrade\n```\n\n## Run the server\nAt the terminal or console type\n```\npython run.py\n```\n## Testing and knowing coverage\nTo run tests run this command at the console/terminal\n```\nnosetests or\npython manage.py test\n```\nTo run tests with coverage run this command at the console/terminal\n```\npython manage.py test_cov or\nnosetests -v --with-coverages\n```\n## Functionality\n  End points | Functionality | Access\n  ------------------|------------------|--------------------\n  /api/v1/auth/register|Post, create account|PUBLIC\n  /api/v1/auth/login|post, login|PUBLIC \n  /api/v1/auth/reset_password|post, logout|PUBLIC \n  /api/v1/auth/logout|post, logout|PUBLIC \n  /api/v1/categories/|post, add category|PRIVATE\n  /api/v1/categories/|Get, retrieve all categories| PRIVATE\n  /api/v1/categories/id|Get, retrieve one category|PRIVATE\n  /api/v1/categories/id|Put, Edit a category| PRIVATE\n  /api/v1/categories/id|Delete, Delete a category| PRIVATE\n  /api/v1/categories/id/recipes|post, add a recipe to a category|PRIVATE\n  /api/v1/categories/id/recipes|Get, retrieve all recipes in a given category| PRIVATE\n  /api/v1/categories/id/recipes/id|Get, retrieve a recipe in a given category|PRIVATE\n  /api/v1/categories/id/recipes/id|Put, Edit a recipe in a given category| PRIVATE\n  /api/v1/categories/id/recipes/id|Delete, Delete a recipe in a given category| PRIVATE\n  -----------------|-----------------------|-------------------\n\n\n\n   Test your setup using a client app like postman\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhadijahkyampeire%2Fnewyummy_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhadijahkyampeire%2Fnewyummy_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhadijahkyampeire%2Fnewyummy_api/lists"}