Item Catalog

This project has been developed so you can be able to create items like (notes, documents, articles, etc.) with the reserved categories.

Getting Started

These instructions will help you out to run this project on your local machine.

Prerequisites

Just download and install Python3, if you haven't install Python3 before, please follow the instructions to install it.

Installing

1. Clone this repo:

$ git clone https://github.com/mtawil/item-catalog.git item-catalog && cd item-catalog

2. Configure Google sign-in by opening config/passport.py, change the consumer_key & consumer_secret. Create it if you don't have one.

3. Install the project requirements:

$ pip3 install -r requirements.txt

4. Create database tables and insert category records:

$ python3 db.py migrate --seed --path database/migrations --seed-path database/seeds

You can use the following command if you want to refresh the database:

$ python3 db.py migrate:refresh --seed --path database/migrations --seed-path database/seeds

Running the application

Run the application:

$ python3 main.py

If you want to disable the application debug: $ export FLASK_DEBUG=0

Open http://localhost:5000 from your browser.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

This project use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Mohammad AlTaweel - Initial work - mtawil

License

This project is licensed under the MIT License - see the LICENSE.md file for details