https://github.com/geffrerson7/site-api
API to create telecommunications antennas sites
https://github.com/geffrerson7/site-api
docker fastapi mongodb pymongo python swagger-docs uvicorn
Last synced: about 1 month ago
JSON representation
API to create telecommunications antennas sites
- Host: GitHub
- URL: https://github.com/geffrerson7/site-api
- Owner: Geffrerson7
- Created: 2023-06-22T04:21:25.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-25T01:30:55.000Z (almost 3 years ago)
- Last Synced: 2025-04-06T10:49:54.993Z (about 1 year ago)
- Topics: docker, fastapi, mongodb, pymongo, python, swagger-docs, uvicorn
- Language: Python
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SITE-API
## Description
API to create telecommunications antennas sites.
## Local Installation
Clone the repository.
```bash
$ https://github.com/Geffrerson7/SITE-API.git
```
Go to the project directory.
```bash
$ cd SITE-API
```
Create a virtual environment.
```sh
$ virtualenv venv
```
Activate the virtual environment.
```sh
# windows
$ source venv/Scripts/activate
# Linux
$ source venv/bin/activate
```
Install the dependencies.
```sh
(env)$ pip install -r requirements.txt
```
Run the project.
```sh
(env) $ python main.py
```
And navigate to the route
```sh
http://127.0.0.1:8000/
```
## Project installation in Docker
Clone the repository
```bash
$ git clone https://github.com/Geffrerson7/SITE-API.git
```
Go to the project directory.
```bash
$ cd SITE-API
```
Run the command
```sh
$ docker-compose up
```
And navigate to the route
```sh
http://127.0.0.1:8000/
```
## Technologies y programming languages
* **Python** (v. 3.11.2) [Source](https://www.python.org/)
* **fastAPI** (v. 0.97.0) [Source](https://fastapi.tiangolo.com/)
* **uvicorn** (v. 3.14.0) [Source](https://www.uvicorn.org/)
* **pymongo** (v. 4.4.0) [Source](https://pymongo.readthedocs.io/en/stable/)
* **pydantic** (v. 1.21.5) [Source](https://docs.pydantic.dev/latest/)
* **openapi** (v. 3.0.2) [Source](https://spec.openapis.org/oas/v3.0.2)
* **python-multipart** (v. 0.0.6) [Source](https://pypi.org/project/python-multipart/)
## Author
- [Gefferson Max Casasola Huamancusi](https://www.github.com/Geffrerson7)