Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jimcostdev/doctorapp
Curso de Django REST Framework
https://github.com/jimcostdev/doctorapp
Last synced: 9 days ago
JSON representation
Curso de Django REST Framework
- Host: GitHub
- URL: https://github.com/jimcostdev/doctorapp
- Owner: JimcostDev
- Created: 2024-11-28T14:26:24.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2024-12-04T12:19:31.000Z (about 1 month ago)
- Last Synced: 2024-12-04T13:25:57.876Z (about 1 month ago)
- Language: Python
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Doctorapp
Doctorapp es un proyecto desarrollado como parte del curso de Django REST Framework en [Platzi](https://platzi.com). Este proyecto tiene como objetivo construir una API RESTful para gestionar un sistema médico que incluye funcionalidades para pacientes, médicos, citas y más.
## Tecnologías
El proyecto está construido con las siguientes herramientas y tecnologías:
- **Django**: Framework principal para el desarrollo del backend.
- **Django REST Framework (DRF)**: Extensión para crear APIs REST de manera sencilla y escalable.
- **PostgreSQL**: Base de datos relacional utilizada en el proyecto.
- **Python**: Lenguaje de programación base para Django.
## Requisitos previos
Antes de iniciar, asegúrate de tener instalado lo siguiente en tu sistema:
- Python 3.8+
- pip (gestor de paquetes de Python)
- PostgreSQL
Opcionalmente, puedes usar herramientas como Docker para simplificar el entorno de desarrollo.
## Instalación
1. **Clona el repositorio:**
```bash
git clone https://github.com/tu-usuario/doctorpp.git
cd doctorpp
```
2. **Crea un entorno virtual:**
```bash
python -m venv venv
source venv/bin/activate # En Windows: venv\Scripts\activate
```
3. **Instala las dependencias:**
```bash
pip install -r requirements.txt
```
4. **Configura la base de datos:**
- Asegúrate de tener PostgreSQL en funcionamiento.
- Crea una base de datos llamada `doctorpp` y un usuario con permisos.
- Actualiza las credenciales de la base de datos en el archivo `settings.py`.
5. **Aplica las migraciones:**
```bash
python manage.py makemigrations
python manage.py migrate
```
6. **Crea un superusuario:**
```bash
python manage.py createsuperuser
```
7. **Inicia el servidor de desarrollo:**
```bash
python manage.py runserver
```
8. **Accede al panel de administración:**
Ve a `http://127.0.0.1:8000/admin/` y usa las credenciales del superusuario que acabas de crear.
## Endpoints principales
El proyecto utiliza Django REST Framework para exponer los siguientes endpoints:
- **Pacientes:**
- `GET /api/patients/` - Lista todos los pacientes.
- `POST /api/patients/` - Crea un nuevo paciente.
- **Médicos:**
- `GET /api/doctors/` - Lista todos los médicos.
- `POST /api/doctors/` - Crea un nuevo médico.
- **Citas:**
- `GET /api/appointments/` - Lista todas las citas.
- `POST /api/appointments/` - Crea una nueva cita.
Consulta la documentación generada por DRF para obtener más detalles.
## Recursos adicionales
- [Documentación oficial de Django](https://docs.djangoproject.com/)
- [Documentación oficial de Django REST Framework](https://www.django-rest-framework.org/)
- [Curso en Platzi](https://platzi.com)