/ICAT.CountryPortalWeb

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

TraCAD - Country Portal Web

Front-end service for ICAT Climate Action Assessment Tool for Transport Sector - TraCAD.

Supported by Initiative for Climate Action Transparency - ICAT.

Built using Node.js 16 and Angular 13.0.2 framework.

Manual Installation

  1. Download and install the Node.js 16 LTS version for your operational system.

  2. Download or clone this repository.

  3. Edit the environment variables in the files environment.prod.ts and environment.ts in src/environments folder. See below for more details about the environmental variables needed.

  4. In the terminal, go to this repository's main folder.

  5. Install the NPM dependencies (including Nest) with the command:

$ npm install --force
  1. Build the app:
$ ng build
  1. Run the app in a dev server. The application will be accessible at http://localhost:4200/
$ ng serve

Google Cloud Installation with Docker

This is an example cloud installation using Docker and Google Cloud Plataform. The provided Dockerfile can be used for local or cloud installation with different services.

  1. In GCP Console, go to Artifact Registry and enable the Artifact Registry API

  2. In the Artifact Registry, create a new repository:

    • Format: Docker
    • Type: Standard
    • Location: desired application location
    • Encryption: Google-managed key

  3. Download and install gcloud CLI.

  4. Download or clone this repository.

  5. Edit the environment variables in the files environment.prod.ts and environment.ts in src/environments folder. See below for more details about the environmental variables needed.

  6. In the terminal, go to this repository's main folder.

  7. Build your container in the Artifacts Register using the provided Dockerfile. The container path can be found on the Artifact Registry's repository page.

$ gcloud builds submit --tag [CONTAINER PATH]
  1. Go to Cloud Run and create a New Service:
    • Choose the option Deploy one revision from an existing container image and select the container image updated in the previous step
    • Add a service name
    • Select the application region
    • Select Allow unauthenticated invocations in the Authentication option
    • In the Container section:
      • Select Container port 80

Noticed that some special permissions in GCP can be necessary to perform these tasks.

Environment Variables

The environment variables should be declared in the files environment.prod.ts and environment.ts in src/environments folder as follow:

Variable name Description
baseUrlAPI Country Portal Service API URL
baseUrlAPIDocdownloadAPI Country Portal Service API URL + /document/downloadDocument
baseUrlAPIDocUploadAPI Country Portal Service API URL + /document/upload2
baseUrlAPIDocUploadAnonymousAPI Country Portal Service API URL + /document/uploadFileAnonymous
baseUrlJsonFile Calculation Engine API URL + /filename
baseUrlMac Calculation Engine API URL + /mac
baseUrlExcelUpload Country Portal Service API URL + /parameter/upload
baseUrlAPIDocReportChartDownloadAPI Country Portal Service API URL + /report/chartDataImage
baseUrlPMU PMU Portal Web API: https://tracadpmu.unops.org
apiKey1 API key. Should be the same as used by the APIs
apiKey2 API key. Should be the same as used by the APIs

Default Users

Some default users are provided for the application test. The Admin user can create, edit or delete new users.

We recommend deleting the default users before deploying the application to production.

Role Username Password Description
Country Admin country_admin country1234 User with administrative permissions
Data Collection Team country_dct country1234 Normal user

Dependencies

This application depends on CountryPortalService and CalculationEngine APIs. The complete dependency diagram of TraCAD Country and PMU applications:

TraCAD Diagram

License

TraCAD - CountryPortalService is Affero GPL licensed.