https://github.com/bitzkort/hommiestock-back
This is the backend repository of the final proyect for the Nosql course
https://github.com/bitzkort/hommiestock-back
fastapi mongodb nosql-databases python redis
Last synced: 4 months ago
JSON representation
This is the backend repository of the final proyect for the Nosql course
- Host: GitHub
- URL: https://github.com/bitzkort/hommiestock-back
- Owner: BitzKort
- Created: 2024-11-23T00:04:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-17T13:01:08.000Z (over 1 year ago)
- Last Synced: 2025-01-23T13:33:00.369Z (over 1 year ago)
- Topics: fastapi, mongodb, nosql-databases, python, redis
- Language: Python
- Homepage:
- Size: 94.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# HommieStock Backend Repository
This repository contains the backend for the final project in the NoSQL databases course. The project uses MongoDB as a non-relational database and a REST API built with FastAPI to deliver a complete inventory management solution.
---
## Project Description
HommieStock is a solution designed to manage the real-time inventory of a retail chain. It provides functionalities for managing products, inventories, orders, suppliers, returns, and reports, all optimized to take full advantage of a NoSQL database like MongoDB.
---
## Prerequisites
Before running the project, ensure you have the following installed:
- Python 3.9 or higher.
- [Pipenv](https://pipenv.pypa.io/en/latest/) for virtual environment management.
- A MongoDB instance (local or cloud, such as [MongoDB Atlas](https://www.mongodb.com/cloud/atlas)) properly configured.
---
## How to Run the Project
Follow these steps to set up and run the backend:
1. Install Pipenv:
```bash
pip install pipenv
```
2. Create an venv:
```bash
pipenv shell
```
3. Install dependencies
```bash
pipenv install -r requirements.txt
```
4. Run de server:
```bash
python -m uvicorn main:app --reload
```
5. Open on your browser: http://127.0.0.1:8000
---
## Important Notes
### MongoDB Connection:
If you encounter issues connecting to MongoDB, make sure that:
1. Your IP address is allowed in your MongoDB Atlas account.
2. The credentials and URI in the configuration file are correct.
### Virtual Environment:
Make sure you are working within the virtual environment created with Pipenv before executing any commands.
---
## Branch Structure
* main: Main branch with the stable version of the project.
* feature/mongodb_structure: Branch with the initial implementation of the MongoDB structure.