diff --git a/.env.template b/.env.template new file mode 100644 index 0000000..02138a3 --- /dev/null +++ b/.env.template @@ -0,0 +1,16 @@ +HOST_PORT=8080 +API_PORT=8080 + +DB_HOST=db +DB_USERNAME=calebburkedev +DB_DATABASE=calebburkedev_production +DB_PASSWORD=DevPwd99! +DB_PORT=5432 + +DB_TRUST_SERVER_CERTIFICATE=true + +VITE_APPLICATION_NAME="CALEB BURKE DEV" +VITE_API_BASE_URL="http://localhost:8080" +VITE_AUTH0_CLIENT_ID="TRlKzdNBynpo9tU1RSmnF0p8d3IEam4J" +VITE_AUTH0_AUDIENCE="alphane-api" +VITE_AUTH0_DOMAIN="https=//dev-7mdjzcgwirhocfwm.ca.auth0.com" \ No newline at end of file diff --git a/README.md b/README.md index 1c1d52b..03f386d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,60 @@ # calebburke.dev +## Deploying + +### Production Environment (remote) + +TODO + +### Test Production Build Locally + +Files: + +- [Dockerfile](./Dockerfile) +- [docker-compose.yml](./docker-compose.yml) +- Non-commited `.env` file + +1. Create a `.env` file in top level directory with the appropriate values. + + ```bash + HOST_PORT=8080 + API_PORT=8080 + + DB_HOST=db + DB_USERNAME=calebburkedev + DB_DATABASE=calebburkedev_production + DB_PASSWORD=DevPwd99! + DB_PORT=5432 + + DB_TRUST_SERVER_CERTIFICATE=true + + VITE_APPLICATION_NAME="CALEB BURKE DEV" + VITE_API_BASE_URL="http://localhost:8080" + VITE_AUTH0_CLIENT_ID="TRlKzdNBynpo9tU1RSmnF0p8d3IEam4J" + VITE_AUTH0_AUDIENCE="alphane-api" + VITE_AUTH0_DOMAIN="https=//dev-7mdjzcgwirhocfwm.ca.auth0.com" + ``` + +2. (optional) If testing build arguments do + + ```bash + docker compose build \ + --build-arg RELEASE_TAG=$(date +%Y.%m.%d) \ + --build-arg GIT_COMMIT_HASH=$(git rev-parse HEAD) + ``` + + and then in the next step drop the `--build` flag. + +3. Build and boot the production image via + + ```bash + docker compose up --build + ``` + +4. Go to and log in. + +5. Navigate around the app and do some stuff and see if it works. + ## Resources - diff --git a/api/src/templates/.gitkeep b/api/src/templates/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docker-compose.yml b/docker-compose.yml index 6803f0e..101465c 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -20,13 +20,13 @@ services: - .env environment: TZ: "UTC" - POSTGRES_USER: "${DB_USER}" - POSTGRES_PASSWORD: "${DB_PASS}" - POSTGRES_DB: "${DB_NAME}" + POSTGRES_USER: "${DB_USERNAME}" + POSTGRES_PASSWORD: "${DB_PASSWORD}" + POSTGRES_DB: "${DB_DATABASE}" ports: - "5432:5432" volumes: - - pg-data:/var/lib/postgresql/data + - db_data:/var/lib/postgresql/data volumes: db_data: