The Ease Inventory Tracker is a simple Flask web application designed to help users manage their inventory of materials. This README.md file provides comprehensive information about the project, including its purpose, structure, setup instructions, and functionalities.
The Ease Inventory Tracker is built using the Flask web framework and SQLite database. It allows users to register, log in, and manage their inventory of materials, including adding, updating, and deleting materials. The project aims to provide a straightforward solution for individuals or small businesses to keep track of their inventory.
The project structure is organized as follows:
eit_app.py: The main Flask application file containing the routes and logic.db_setup.py: Script to create the SQLite database file (inventory.db) and set up the SQL schema for the app.db_methods.py: This module contains all the methods used to interact with the database to manipulate user information.static/: Directory containing static files (CSS, JS).templates/: Directory containing HTML templates.static/styles/: Directory containing CSS files.static/images/: Directory containing all the image files.static/scripts/: Directory containing JavaScript files.requirements.txt: Contains all the dependancies required to run the web app.README.md: Comprehensive documentation for the project.
Follow the steps below to set up the Ease Inventory Tracker on your local machine:
-
Clone the repository:
git clone https://github.com/phila-hh/ease_inventory_tracker.git
-
Navigate to the project directory:
cd ease_inventory_tracker -
Install the required dependencies:
pip install -r requirements.txt
To run the Ease Inventory Tracker application, execute the following command:
python3 eit_app.pyAccess the application in your web browser at http://localhost:5000.
Before running the application, set up the SQLite database using the provided scripts:
-
Run
db_setup.pyto create the database and necessary tables:python3 db_setup.py
Contributions to the Ease Inventory Tracker project are welcome. Follow these steps to contribute:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Implement your changes.
- Test thoroughly.
- Create a pull request.
For any inquiries or feedback, please contact:
- Author: Filimon Haftom
- Email: filimon.haftomh@gmail.com
- GitHub: phila-hh
- Twitter: @phila_hh
Feel free to reach out for assistance, feedback, or collaboration!