Run 🚀

Create a Github token to get read access to GitHub Package Registry

Prepare your environment variables

Frontend:

CONTAINER ENV	HOST ENV	Description
GITHUB_AUTH_TOKEN	GITHUB_AUTH_TOKEN	GitHub package registry token (read)
GOOGLE_MAPS_API_KEY	Optional, set to enable feature	Google Maps API Key
GOOGLE_ANALYTICS_ID	Optional, set to enable feature	Google Analytics ID

Backend:

CONTAINER ENV	HOST ENV	Description
DJANGO_SECRET_KEY	DEV_DJANGO_SECRET_KEY	Django secret key
EMAIL_HOST	DEV_SMTP_SERVER	SMTP service host (default port 587)
EMAIL_HOST_USER	DEV_USER_MAIL	Email sender account
EMAIL_HOST_PASSWORD	DEV_USER_MAIL_PASSWORD	Email sender account password

📑 NOTE You can generate Django secret keys here

📑 NOTE If you do not have / need to use a SMTP service you can output the email in the console by adding EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend' in server/agube/settings.py (email user and pasword are ignored)

Prepare docker

docker volume create --name agube-db-data
docker volume create --name agube-data

Run docker

docker compose up

Generate DB (in new terminal)

docker exec -it agube-be python3 manage.py migrate

Create a Manager account (password input will prompt)

python manage.py createmanager <username> <email> <first_name> <last_name> <phone_number>

That's all 🥳, ensure that works -> localhost

Getting Started 🛠️

• Server 🖥️

• Client 👨‍💻

• API 🌍

Contributors ✨

Fran 📆 💻 🎨 🐛 💼 📖 🤔 🚇 🚧 🔬 👀

Santiago Bolás Lago 📆 💻

Germán Martín Garisto Viso 📆 💻

LICENSE

Apache License Version 2.0