Setup up Job board

Create environment file

• Copy .env.example to .env
• Update the environment variables

Run containers:

docker-compose up -d. It will create API, DB, and DB admin containers

REST API

API docs

• http://127.0.0.1:8000/docs

Setup authentication with Google

1. Access to the Google Cloud Console with your Google account:
2. Create a new project
3. Go to the Credentials page
4. Create a new OAuth client ID
5. Consent screen:
   • Then, set up the App Name, Support Email
   • Add userinfo.email and userinfo.profile, and openid scopes.
   • Add your email as a test user to start testing the application.
6. After the consent screen is ready we can finally create the OAuth client id. So we go to Credentials -> Create Credentials -> OAuth client ID.
7. Set up the OAuth client ID:
   • Application type: Web application
   • Name: Job board
   • Authorized JavaScript origins: For example, http://127.0.0.1:8000
   • Authorized redirect URIs: http://127.0.0.1:8000/v1/auth
8. After creating the client, it will pop a modal with your client ID and client secret
9. Copy the client ID and client secret to the .env file in the GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET env variables.

Job chat using websocket.

Job chat endpoint.

Accessing this endpoint in browser you will create new websocket connection and be able to send messages which will be broadcasted to all participants.

• http://127.0.0.1:8000/job-chat

Manage DB

Ensure the table created:

1. Access PostgreSQL DB: dco exec db psql --username=user_one --dbname=job_board
2. List of relations: # \dt

Select data from DB table:

1. dco exec db psql --username=user_one --dbname=job_board
2. select * from table;

Access PhAdmin to manage DB through web-based GUI

1. Access http://localhost:8080/
2. Fill username and password (from docker-compose.yml) PGADMIN_DEFAULT_EMAIL PGADMIN_DEFAULT_PASSWORD
3. Create new server:

• Add your server name
• Host name/address: postgres_container
• Port: 5432
• Username: user_one
• Password: user_one

Tests

Run tests

• From root directory execute: pytest

Deployment

Deployment to GCP (Deprecated)

• Create GCP account
• Install gcloud CLI: https://cloud.google.com/sdk/docs/install
• gcloud init
• Check project ID: gcloud config get-value project
• Build container image using Cloud Build: gcloud builds submit --tag gcr.io/PROJECT-ID/api
• Deploy container image to Cloud Run using env variables (Take values from your .env file): gcloud run deploy --image gcr.io/PROJECT-ID/api --platform managed --update-env-vars POSTGRES_USER=x,POSTGRES_PASSWORD=x,POSTGRES_SERVER=x,POSTGRES_PORT=x,POSTGRES_DB=x,POSTGRES_DB_DRIVER=x
• Check deployment: gcloud run services list

Deployment to http://fly.io/. fly.toml file is used for deployment.

• Create account
• Install flyctl CLI: https://fly.io/docs/getting-started/installing-flyctl/
• fly auth login
• fly apps create
• Build app: fly launch
• Add DB secrets to app: fly secrets set POSTGRES_USER=x POSTGRES_PASSWORD=x env_name=env_value
• Deploy app: fly deploy
• Check deployment status: fly status
• Check logs: fly logs
• Check app details: fly info

Certificates

• Add certificates: fly certs create app_name
• Check certificates: fly certs show app_name

Postgres DB usage

• Create Postgres DB: fly postgres create
• Access logs: fly postgres connect -a my-db-app
• Select all DBs: type \
• Choose one DB: \connect DB_NAME
• List tables: \dt

TO DO