/flask-inventory-api-with-auth

An items inventory API with user authentication written in Python using Flask

Primary LanguagePython

Issues MIT License LinkedIn


Logo

Flask Inventory App

An awesome README template to jumpstart your projects!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

I am going through a course on Flask on Udemy, this is just a repo which I created to play around with Flask and various associated libraries.

  • Your time should be focused on creating something amazing. A project that solves a problem and helps others
  • You shouldn't be doing the same tasks over and over like creating a README from scratch
  • You should implement DRY principles to the rest of your life 😄

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

  • Flask
  • Python
  • Postgres
  • Docker

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm 
    npm install npm@latest -g

Installation

Setting this project is fairly simple on your local system which has Python >= 3.7 installed. Preferably, create a new virtual environment to install dependencies. Activate this virtual environment and install the dependencies through the requirements.txt file.

Next step would be to setup database, we use SQLAlchemy and Postgres for databases and migrations.

flask db init
flask db migrate
flask db upgrade

The first line would create a migrations folder inside your project to keep track of changes in the database app as your app grows. The second command would lock migration changes in the database but the tables won't be actually created until you run the upgrade command.

(back to top)

Roadmap

  • Boilerplate created
  • Added authentication and a couple of more sample models.
  • Add Additional Templates w/ Examples
  • Add "components" document to easily copy & paste sections of the readme

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

Amit Prafulla (apfirebolt) - @your_twitter - aspper20@gmail.com

Project Link: https://github.com/Apfirebolt/flask-inventory-api-with-auth

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)