Translator

Backend Setup

First, create a Postgresql database and store the database name and host in case of using an external service.

Then install the dependencies. To do so, go to the Backend folder and run pip install -r requirements.txt.

Django needs a secret key for encription. To create one run: python -c "from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())" and copy the output key.

Then, create the superuser. To do so, go to the Backend/translatorapp_v2 folder and run python manage.py createsuperuser. Make sure that the username and email are both set to your email.

Create a file named .env inside Backend/translatorapp_v2. The file should look something like this:

# database configuration
DB_PASSWORD="<database passsword>"
DB_USER="<database user>"
DB_HOST="<database host: localhost in case of running locally, instead external ip>"
DB_PORT="<database port, should be 5432>"
DB_NAME="<database name>"

VARIANT="<arn or rap>"

# For email configurations
EMAIL_USER="<email account for sending emails>"
EMAIL_KEY="<email account key from email_user>"
INVITATION_GUIDE_URL="<link to invitation guide sent in invite email>"
SUPPORT_EMAIL="<support email sent in invite email>"

DJANGO_SUPERUSER_USERNAME="<username from superuser created before>"
DJANGO_SUPERUSER_EMAIL="<email from superuser created before>"
DJANGO_SUPERUSER_PASSWORD="<password from superuser created before>"

PRODUCTION="False"
SECRET_KEY="<Django key created in previous step>"
APP_FRONTEND_URL="http://localhost:3000"

Then, run database migrations. To do so, go to the Backend/translatorapp_v2 folder and run python manage.py migrate

Frontend Setup

Open the Frontend/translator and Run npm i to install the dependencies

Create a file named .env inside Frontend/translator. The file should look something like this:

API_URL = "http://127.0.0.1:8000"
VARIANT = "<arn or rap>"

Run Frontend

Open the Frontend/translator folder and run npm run dev

Run Backend

In another console, open the Backend/translatorapp_v2 folder and run python manage.py runserver

Open the Website

Open a browser and navigate to http://127.0.0.1:3000.

For deployment

We designed the following GCP deployment:

We have provided two actions for deploying backend and frontend to GCP. It's important to set the same environment variables as in .env file but as secrets. Aditionally, your GCP project variables. Check action files to see specific variable names. Both frontend and backend urls are retrieved through SERVICE_NAME_BACKEND and SERVICE_NAME_FRONTEND.

The you can manually run actions on actions section in github and setting as input variant.