Running locally

run app locally

• install node dependencies for app: (in app folder)

npm install 

• Fill in VITE_API_URL with desired backend in app/.env.local (example env file provided).
• run app locally (in app folder)

npm run dev

• the app will be available on localhost:5173

run app & backend

• Fill in VITE_API_URL with localhost:5000 in app/.env (example env file provided).
• run docker with local containers for db, db-admin, app & api:

docker-compose -f compose.yaml up --build 

Deployment

• install node dependencies for deployment: (in deployment folder)

npm install 

• Fill in FTP_HOST, WEBSITE_ADMIN_USE and WEBSITE_ADMIN_PW in deployment/.env (example env file provided).
• Fill in VITE_API_URL with desired backend in app/.env.production (example env file provided).

deploy app

• build app: (in app folder)

npm run build

• deploy previously build app: (in deployment folder)

npm run deploy-app

deploy api

• deploy previously build app: (in deployment folder)

npm run deploy-api

Tools

setup

• install python (e.g. on ubuntu)

sudo apt-get update && sudo apt install python3 python3-pip

or download for mac python downloads

• set up local environment

python -m venv .venv

• install jupyterlab

. .venv/bin/activate && pip install jupyterlab

ussage

• in tools folder: run jupyter lab

. .venv/bin/activate && jupyter lab

• upen provided link with token in url

testing

• install php, php-sql, php-unit and php-mysql
• start database

docker
 run --rm -e MYSQL_ROOT_PASSWORD=test -e MYSQL_DATABASE=weddingsite_db -e MYSQL_USER=test -e MYSQL_PASSWORD=test -p 3306:3306 mysql:8.2.0

• run tests (from the api folder)

DB_SERVER=127.0.0.1 ./vendor/bin/phpunit