https://github.com/sanafagal/mongodb-project
API for event management at Politécnico Colombiano JIC, enabling the registration and management of events, talks, conferences, and meetings, with data stored in a NoSQL database.
https://github.com/sanafagal/mongodb-project
atlas env fastapi mongodb pydantic python uvicorn
Last synced: 2 months ago
JSON representation
API for event management at Politécnico Colombiano JIC, enabling the registration and management of events, talks, conferences, and meetings, with data stored in a NoSQL database.
- Host: GitHub
- URL: https://github.com/sanafagal/mongodb-project
- Owner: SanAfaGal
- Created: 2024-05-26T03:59:50.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-06-01T00:06:03.000Z (12 months ago)
- Last Synced: 2025-01-21T01:12:17.067Z (4 months ago)
- Topics: atlas, env, fastapi, mongodb, pydantic, python, uvicorn
- Language: Python
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Instructions to Run:
1. Clone the repository:
```
git clone https://github.com/SanAfaGal/mongodb-project
```
2. Navigate to the project directory:
```
cd mongodb-project
```
3. Create a virtual environment and install packages:
```
pip install -r requirements.txt
```
4. Ensure you have the MongoDB Atlas connection string in the .env file:
```
MONGODB_URI=''
```
5. Create 3 collections in the 'event_management' database:
```
users
events
comments
```
## Make sure to
- Include your IP address in the IP access list by selecting the Network Access tab.
- Create a user and password to access the database.
- Update the correct username and password in the MONGODB_URI environment variable.
6. Run the program in the terminal:
```
uvicorn app:app
```
## Usage and Examples
To view the documentation and test the endpoints, go to the following URL once the project is running:
```
http://127.0.0.1:8000/docs
```