Trad: an instantaneous translation application between two people, one of whom is allophone
Copyright (C) <2022> <Innovation Department, DSI Pôle Emploi>
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.
This project is distributed under the GNU AFFERO GENERAL PUBLIC LICENSE V3.0. Please check the LICENSE file.
This project is the backend of the application. The frontend is trad-frontend project. Checks readme to install it. The purpose of this application is describe in the documention of the frontend part.
- Create GCP Infrastructure with Terraform
- Create Deepl glossaries
- Configure gitlab CI/CD chain
- Deploy backend services
- Create the Firebase application
- Deploy frontend application
- Configure security
--- This step need to be done only for the project initialization ---
Build Infrastructure - Terraform GCP
--- This step need to be done only for the project initialization ---
--- This step need to be done only for the project initialization ---
Add CI/CD variables in the "Settings > CI/CD Settings > Variables"
- GCLOUD_SERVICE_KEY_FILE => Get the json key of the gitlab-sa service account from GCP console in secret manager
- GCP_PROJECT => Project ID for each environment
- TF_VAR_FILE => Same for all environment project_id = gcp_project region = "europe-west1" schedule: "0 * * * *" oidc_audience = "trad.fr" app_engine_region_mapping = { "europe-west1": "europe-west1", "us-central1": "us-central", }
- CB_DEFAULT_VAR_FILE => CloudBuild default environment variable GCP_PROJECT: gcp_project LOCATION: europe-west1
- CB_TRANSLATION_VAR_FILE => CloudBuild translation CloudRun environment variable, add DEEPL_API_KEY: xxxx DEEPL_GLOSSARY_XX_XX: xxxx ...
- CB_TOKEN_VAR_FILE => CloudBuild token-broker CloudRun environment variable API_GATEWAY_AUDIENCE: trad.fr
Build and deploy services (6 services)
--- This step need to be done only for the project initialization ---
Log in to the Firebase console, https://console.firebase.google.com, then click on "Add project"
Select your existing Google Cloud project from the dropdown menu, then click on "Continue".
Click on "Add Firebase".
Enable authentication for your Firebase project to use Firestore:
Click on "Authentication" from the navigation panel.
Go to the "Sign-in" Method tab.
Enable Email/Password and the anonymous authentication, for example:
Add Firebase to your app by following the web guide.
The source code of frontend application is in trad-frontend project. See the README.md file to install it.
--- This step need to be done only for the project initialization ---
To set up and deploy the firestore security rules, open the Rules tab in the Cloud Firestore section of the Firebase console.
Copy the rules from rules.txt, Write your rules in the online editor, then click on "Publish"
You must deploy the web application before the next step in order to have the 2 APIs:
- Identity Toolkit API
- Token Service API
In APIs and Service (on GCP Platform), the Credentials part, we could restrict the API key to specific websites and Api's (only the Identity Toolkit API and Token Service API)
First step:
Second step:
If you use application with Firebase authentication (and not with OIDC mechanism), create user in firebase; this user will be used to access to the application.
