-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9 from Fer-Bar/docs/update-readme
Update readme file and updated gitignore
- Loading branch information
Showing
2 changed files
with
42 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,40 @@ | ||
# Albercan Backend | ||
|
||
Construido con Django 5.0 y python 3.10 | ||
### Readme en progreso ... | ||
Este proyecto está construido con **Django 5.0** y **Python 3.10**. | ||
|
||
## Estructura del proyecto | ||
|
||
El proyecto consta de los siguientes directorios y archivos principales: | ||
|
||
- `.github`: Contiene los archivos de configuración de GitHub. | ||
- `albercan_backend`: Contiene el código fuente del backend. | ||
- `envs`: Contiene los archivos de entorno. | ||
- `people`, `pet`, `structure`, `utils`: Contienen el código fuente de las diferentes partes del proyecto. | ||
|
||
## Instalación y ejecución con Docker | ||
|
||
Para instalar y ejecutar el proyecto con Docker, sigue estos pasos: | ||
|
||
1. Construye la imagen de Docker: | ||
|
||
```bash | ||
docker build -t albercan_backend . | ||
``` | ||
|
||
Para ejecutar el proyecto con Docker Compose: | ||
```bash | ||
docker-compose up | ||
``` | ||
|
||
# Instalación y ejecución con Poetry | ||
Para instalar y ejecutar el proyecto con Poetry, sigue estos pasos: | ||
|
||
1. Instala las dependencias del proyecto: | ||
```bash | ||
poetry install | ||
``` | ||
|
||
2. Ejecuta el servidor de desarrollo de Django: | ||
```bash | ||
poetry run python manage.py runserver | ||
``` |