Bread App

Data-driven baking application

Quick-start: user

Prerequisites

Install

pipenv install

Usage

pipenv run ?

Run tests

pipenv run pytest

Quick-start: developer

Prerequisites

Package requirements are saved in a Pipfile, so you will need Pipenv to install them.

Install

pipenv install --dev

Usage

Start uvicorn development server:

pipenv run uvicorn api.main:app --reload

You should then be able to access the api:

• http://127.0.0.1:8000
• http://127.0.0.1:8000/docs - interactive api documentation
• http://127.0.0.1:8000/redoc - alternative interactive api documentation

Run tests

pipenv run python -m pytest

---

Author

👤 Aidan McBride

• Github: @aidan-mcbride

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2019 Aidan McBride.

This project is GPL--3.0 licensed.

---

This README was generated with ❤️ by readme-md-generator