This project showcases the backend of a product inventory management system built using FastAPI as the Framework, PosgreSQL as the Database and following a Layered Architechture.
- 📌 Project Scope
- 🔧 Technologies
- 📐 Architecture
- 💾 Database
- 🧪 Testing
- 🌐 API Endpoints
- 📂 Directory Structure
- 📥 Installation
- 🚀 Usage
This project simulates the backend of an inventory management system with a focus on creating a robust and scalable code. The project scope includes functionalities such as all CRUD interactions with the products along with the posibility to group them by category or producer. Also the ability to track sales, automatically updating the stock count.
- Python 🐍
- FastAPI ⚡
- PosgreSQL 🐘
- Docker 🐋
- Pytest 🧪
The project's code organization follows a layered architecture, where each layer communicates with the one above or below it. This allows some processes such as data validation and database queries to be separated, making it easier to track the process and prevent security bugs.
This layer handles the http requests. After receiving the request it calls the logic layer and after receiving the response it returns a json with the information.
After the http request, this layer validates the data received from the APIs layer and calls the Data Access layer if the data is valid, otherwise it returns an error message.
This layer makes the Database queries with the validated data from the Logic layer and returns the information.
The last layer is the Database itself, where the app data is stored.
The database is a PosgreSQL one and is hosted in a Docker container. It contains 4 different tables:
- Categories: Contains the categories of the products.
- Producers: Contains the different producers.
- Products: Contains all the products of the bussiness and their information.
- Sales: Contains the transaction history.
Stores the name of the category/producer to be referenced in the products table. This makes it easier to divide the products into different groups and manipulate them more efficiently.
Stores a product's name, price, stock, category, and producer.
Keeps track of the sales made, tracks the stock movement and automatically updates the stock of products after each sale.
This project contains 50 tests that checks APIs functionalities along with the data validation process, making requests with invalid data and checking if the error message pops up correctly. All these tests are automatically executed by github after every push/pull request. You can check the green checkmark "✅" at the top of the repository. This ensures that everything is working correctly.
To properly test the CRUD endpoint, the database must be recreated before running the tests. Otherwise, the tests will fail.
The endpoints include CRUD capabilities over the 4 tables, a filter query for products, stock update options and an easy way to update many prices at once. This last feature is especially useful in countries with high inflation, something that is not normally present in inventory management systems.
For specific information about all the endpoints and methods allowed click here!
- .github/workflows/: Tells githb to run the tests.
- backend/: Backend layers.
- apis/: App endpoints.
- utils/: Response functions used in the apis.
- logic/: Data validation process.
- validations/: Validation functions used in multiple instances.
- data_access/: Database comunication.
- utils/: Success check function.
- models/: Models used to encapsulate data.
- apis/: App endpoints.
- database/: Database scripts.
- tests/: Project tests.
- readme_images/: Images for the README you are reading
- Python 🐍
- Docker 🐋
- Git 🛠️
- Clone the repository:
git clone https://github.com/JuanNovas/Product-Inventory-Management-System.git cd Product-Inventory-Management-System - Create and activate a virtual environment:
python -m venv venv source venv/bin/activate # On Windows use `venv\Scripts\activate`
- Install dependencies:
pip install -r requirements.txt
- Set up the database container:
docker-compose up -d
- Execute the main script:
python main.py
To try this application yourself, you can use tools like Postman or Insomnia. There is also a built-in option from FastAPI that will display a Swagger web page at http://127.0.0.1:8000/docs when you run the program.
Thanks for checking out my project, give me a star 🌟 if you like it. For any questions or feedback, please contact me at [email protected].