docs: 📝 add usage and build instructions

- Add instructions for running the application using the prebuilt image with docker-compose.
- Add instructions for building the image locally.
- Include details on configuring environment variables within the docker-compose file.
This commit is contained in:
Maicol Battistini 2025-01-24 10:23:01 +01:00
parent cfc5c570a1
commit c9211692a7
No known key found for this signature in database
1 changed files with 15 additions and 0 deletions

15
README.md Normal file
View File

@ -0,0 +1,15 @@
# Usage (production)
If you are using the prebuilt image only `docker-compose.yml` is needed. Just configure the enviroment variables as described in the `docker-compose.yml` file and run with:
```bash
docker-compose up -d
```
If you are not using the prebuilt image, clone the project and run `docker-compose up -d` (comment image and uncomment build in `docker-compose.yml`)
# Build
Build the image with:
```bash
docker build -t d4science/website .
```
# Usage (development)
Just run `docker-compose -f docker-compose.dev.yml up -d`