/altschool-pizza

A simple PIzza Delivery API built with Python Flask framework

Primary LanguagePythonMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License Twitter


Logo

AltSchool Pizza

Explore the Docs »
View Demo · Report Bug · Request Feature


Table of Contents
  1. About AltSchool Pizza
  2. Lessons Learned
  3. Usage
  4. Sample
  5. License
  6. Contact
  7. Acknowledgements

back to top


About AltSchool Pizza

AltSchool Pizza is a RESTful API which enables users to register accounts on the Heroku-powered app and place pizza orders. CRUD operations can then be carried out on these orders, with an easy-to-use Swagger UI setup for testing and integration with the front end.

This pizza delivery API was built by Ze Austin during Backend Engineering live classes at AltSchool Africa.

back to top

Built With:

Python Flask SQLite

back to top


Lessons Learned

Creating this API helped me learn and practice:

  • API Development
  • App Deployment with Heroku
  • Testing
  • Documentation
  • Debugging
  • Routing
  • Database Management
  • Internet Security
  • User Authentication
  • User Authorization

back to top


Usage

To use this API, follow these steps:

  1. Open the Heroku app on your browser: https://altschool-pizza.herokuapp.com

  2. Click 'auth' to reveal a dropdown menu of authentication routes

  3. Register via the '/auth/signup' route, if you are a new user

  4. Sign in via the '/auth/login' route to generate a JWT token. Copy this access token without the quotation marks

  5. Scroll up to click "Authorize" at top right. Enter the JWT token in the given format, for example:

    Bearer this1is2a3rather4long5hex6string
    
  6. Click 'Authorize' and then 'Close'

  7. Now authorized, you can create, view, update and delete orders via the many routes in 'orders'

  8. When you're done, click 'Authorize' at top right again to then 'Logout'

back to top


Sample


AltSchool Pizza Screenshot


back to top


License

Distributed under the MIT License. See LICENSE for more information.

back to top


Contact

Dr Austin Wopara - @Ze_Austin - austinwopara@gmail.com

Project Link: AltSchool Pizza

back to top


Acknowledgements

This project was made possible by:

back to top