breakfastapi
The most delicious API on the web. π£ π π
File Explorer
Download Latest Version (.zip)- main.yml
- __init__.py
- database.py
- recipes.db
- BreakFastAPI.png
- favicon.ico
- error.py
- recipe.py
- .gitignore
- __init__.py
- Dockerfile
- LICENSE
- main.py
- README.md
- requirements.txt
- test_recipes.py
# Installation Guide
1. Get the code
git clone https://github.com/MariiaSizova/breakfastapi
Downloads the entire project code from GitHub to your computer.
cd breakfastapi
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t breakfastapi .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 breakfastapi
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Python
EasyPrerequisites
pip install -r requirements.txt
Installs the Python libraries listed in requirements.txt (or similar).
python main.py
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
// repository documentation
Was this content helpful?
(0 ratings)