CAT (startup repo)

About | Initial steps | OS | Local env | Bash scripts | Bash shell | DB actions

About

• this setup is best suited for development inside Docker
• VSCode's Dev Containers extension will be useful

flowchart TD
  CAT --> |cat-db container| Mongo
  CAT --> |cat-api container| Node
  CAT --> |cat-fe container| React
  CAT --> |cat-shared container| Shared
  CAT --> |cat-stripe container| Stripe

Loading

Initial steps

• make sure you have Docker up on your machine
• ask for environment variables

OS

Add new entry to /etc/hosts file

127.0.0.1 host.docker.internal

How to startup local environment

Clone this repo using https and GitHub personal access token

git clone https://<PAT>@github.com/Karmello/cat-start.git

Create .env file in the root of the project and fill it in with the right values

PAT=...

NODE_ENV=development
CLIENT_PORT=3000
SERVER_PORT=8000
API_PORT=9000
API_PORT_TEST=10000
LOCAL_PROD_PORT=11000

FE_URL=http://cat-fe:3000
API_URL=http://cat-api:9000
API_PATH=/api

MONGO_USER=...
MONGO_PASS=...
MONGO_URI=mongodb://cat-db:27017/db
MONGO_URI_LOCAL=mongodb://cat-db:27017/db
MONGO_URI_TEST=mongodb://cat-db:27017/db-test
MONGO_URI_DEV=...
MONGO_URI_STAGING=...
MONGO_URI_PROD=...

AWS_ACCESS_KEY_ID=...
AWS_SECRET_ACCESS_KEY=...
AWS_BUCKET_URL=https://cat-local.s3.eu-central-1.amazonaws.com
AWS_BUCKET_NAME=cat-local

FULL_ACCOUNT_PAYMENT_REQUIRED=no
STRIPE_API_KEY=
DONATION_PAYMENT_LINK=https://buy.stripe.com/test_6oEaInftt7vj3cYfZ1
FULL_ACCOUNT_PAYMENT_LINK=

AUTH_SECRET=...
EMAIL_USER=cat.web.app@gmail.com
EMAIL_PASS=...
ADMIN_USER_ID=678806d4274e9d0b993be702
RECAPTCHA_SITE_KEY=...
HONEYBADGER_API_KEY=...
OPENAI_API_KEY=...

Start Stripe (optional)

docker compose up --detach cat-stripe

Start database

docker compose up --detach cat-db

Build and start API

docker compose build --no-cache cat-api

docker compose up --detach cat-api

Build and start FE

docker compose build --no-cache cat-fe

docker compose up --detach cat-fe

Build and start shared repo

docker compose build --no-cache cat-shared

docker compose up --detach cat-shared

Manage all services at once using bash scripts

cmd/down

cmd/build

cmd/up

Verify services

http://localhost:9100

http://localhost:8100/info

http://localhost:3100

Getting bash shell

Docker

docker exec -it cat-fe /bin/bash

docker exec -it cat-api /bin/bash

docker exec -it cat-shared /bin/bash

Heroku

heroku run bash -a cat-api-development

Database actions

• there's db folder in the root of API repository
• it contains ready scripts to perform all sorts of db actions

Available actions

seed | seed-static | empty | check | notify | copyto | edit

Available environments

local | dev | staging | prod

Examples

yarn db local seed

yarn db prod check

yarn db prod copyto staging