https://github.com/jimcostdev/jimcostdev_api
Este proyecto se encuentra en desarrollo y tiene como objetivo la creación de una API para la gestión de portafolios y currículums (CV). Surge de la necesidad de contar con una página web personal para exhibir mis habilidades y convertir esa información en un formato de CV.
https://github.com/jimcostdev/jimcostdev_api
fastapi mongodb python
Last synced: about 2 months ago
JSON representation
Este proyecto se encuentra en desarrollo y tiene como objetivo la creación de una API para la gestión de portafolios y currículums (CV). Surge de la necesidad de contar con una página web personal para exhibir mis habilidades y convertir esa información en un formato de CV.
- Host: GitHub
- URL: https://github.com/jimcostdev/jimcostdev_api
- Owner: JimcostDev
- Created: 2024-01-10T15:35:36.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-01-27T13:26:53.000Z (over 1 year ago)
- Last Synced: 2025-01-27T14:31:24.266Z (over 1 year ago)
- Topics: fastapi, mongodb, python
- Language: Python
- Homepage: https://jimcostdev.com
- Size: 94.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# JimcostDev API
API REST desarrollada con FastAPI para gestionar dinámicamente los datos de mi CV y portafolio profesional. Este backend alimenta tanto mi sitio web personal como la versión descargable de mi currículum.
## 🌐 Ecosistema del Proyecto
Este repositorio forma parte de un ecosistema de 3 aplicaciones:
- **[jimcostdev_api](https://github.com/JimcostDev/jimcostdev_api)** - API REST (FastAPI + MongoDB) ← *Estás aquí*
- **[jimcostdev-astro](https://github.com/JimcostDev/jimcostdev-astro)** - Sitio web principal (Astro + Tailwind CSS)
- **[jimcostdev_cv](https://github.com/JimcostDev/jimcostdev_cv)** - CV descargable (HTML + SCSS + JavaScript)
## 🚀 Tecnologías Utilizadas
[]()
[](https://fastapi.tiangolo.com/)
[]()
## 📦 Instalación
### 1. Clonar el repositorio
```bash
git clone https://github.com/JimcostDev/jimcostdev_api.git
cd jimcostdev_api
```
### 2. Crear y activar el entorno virtual
**Windows:**
```bash
python -m venv venv
venv\Scripts\activate
```
**macOS / Linux:**
```bash
python3 -m venv venv
source venv/bin/activate
```
### 3. Instalar dependencias
```bash
pip install -r requirements.txt
```
**🔄 Actualizar dependencias (opcional):**
```bash
# Reinstalar todas las dependencias
pip uninstall -y -r requirements.txt
pip install -r requirements.txt
# Actualizar un paquete específico
pip install --upgrade nombre-del-paquete
```
### 4. Configurar variables de entorno
Crea un archivo `config.env` dentro de `app/core/`:
```env
MONGO_URI=your_mongodb_connection_uri
JWT_SECRET_KEY=your_secret_key
```
*También puedes exportar estas variables directamente en tu sistema operativo.*
### 5. Configurar la base de datos
Asegúrate de tener MongoDB instalado y crea una base de datos llamada `jimcostdev_api` con las siguientes colecciones:
- `contact`
- `education`
- `perfil`
- `projects`
- `social_networks`
- `work_experience`
- `users`
### 6. Ejecutar el servidor
```bash
cd app
fastapi dev main.py
```
La API estará disponible en `http://localhost:8000`
## 📖 Documentación
Accede a la documentación interactiva de la API:
- **Swagger UI:** `http://localhost:8000/docs`
- **Redoc:** `http://localhost:8000/redoc`
También puedes usar herramientas como **Postman** o **Insomnia** para probar los endpoints.
## 🤝 Contribuciones
¡Las contribuciones son bienvenidas! Si deseas mejorar algo, abre un **pull request** o crea un **issue**.
## 📜 Licencia
Este proyecto está bajo la **Licencia MIT**. Consulta el archivo [LICENSE](./LICENSE) para más detalles.
## 📬 Contacto
Para más información, visita mi sitio web: [jimcostdev.com](https://jimcostdev.com)