https://github.com/juanpq26/blogging-platform-api
https://github.com/juanpq26/blogging-platform-api
fastapi poetry pydantic python sqlite sqlmodel uvicorn
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/juanpq26/blogging-platform-api
- Owner: JuanPQ26
- Created: 2025-02-13T00:49:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-13T00:51:52.000Z (over 1 year ago)
- Last Synced: 2025-04-12T14:46:49.378Z (about 1 year ago)
- Language: Python
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Blogging Platform API
Este es un proyecto base que utiliza **FastAPI** con **SQLModel** y **SQLite**, administrado con **Poetry** para la gestión de dependencias.
## Requisitos
Antes de comenzar, asegúrate de tener instalado lo siguiente:
- [Python](https://www.python.org/) 3.8+
- [Poetry](https://python-poetry.org/docs/#installation)
## Instalación
Clona el repositorio y entra en la carpeta del proyecto:
```bash
git clone https://github.com/tuusuario/tu-repo.git
cd tu-repo
```
Instala las dependencias con Poetry:
```bash
poetry install
```
Activa el entorno virtual:
```bash
poetry shell
```
## Ejecución del servidor
Para iniciar el servidor de desarrollo de FastAPI, usa el siguiente comando:
```bash
poetry uvicorn app.main:app --reload
```
El servidor estará disponible en: [http://127.0.0.1:8000](http://127.0.0.1:8000)
La documentación interactiva de la API está en:
- **Swagger UI**: [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs)
- **ReDoc**: [http://127.0.0.1:8000/redoc](http://127.0.0.1:8000/redoc)
## Despliegue
Para ejecutar el servidor en producción, usa:
```bash
uvicorn app.main:app --host 0.0.0.0 --port 8000 --workers 4
```