Skip to content

Commit

Permalink
Merge pull request #9 from Fer-Bar/docs/update-readme
Browse files Browse the repository at this point in the history
Update readme file and updated gitignore
  • Loading branch information
enrker authored Apr 12, 2024
2 parents e856cfe + 5758aff commit c7749c0
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 3 deletions.
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -114,4 +114,7 @@ GitHub.sublime-settings
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
.history
.history

# Static Files
static/
40 changes: 38 additions & 2 deletions README.md
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
```

0 comments on commit c7749c0

Please sign in to comment.