README.md

[]

BCAT

B.C. Active Transportation

Prerequisites

• Node.js version 16.18.1
• React version 18.1.0
• Next.js version 12.3.1
• Nest.js version 8.2.3
• TypeORM version 0.2.41
• TailwindCSS version 3.2.4
• Docker - for local development in place of Openshift
• PostgreSQL - version 12.12

Mandatory Dependencies

• IDIR service account with access to Active Directory (LDAP) service

Local Development

Configuration

Use the following steps to configure the local development environment

1. Clone the repository:

   git clone https://github.com/bcgov/BCAT.git
   
   

2. Configure the development settings

   • Create the client/.env file and add the following content:

      NEXT_PUBLIC_REDIRECT_URI=https://localhost:3000
      NEXT_PUBLIC_KC_AUTH_URL=<auth-url>
      NEXT_PUBLIC_KC_AUTH_REALM=<realm-id>
      NEXT_PUBLIC_KC_AUTH_CLIENT_ID=<client-id>
      NEXT_PUBLIC_SERVER_URL= https://localhost:8080/api/v1
      NEXT_PUBLIC_INFRASTRUCTURE_PROJECT=<formId>
      NEXT_PUBLIC_NETWORK_PROJECT=<formId>
   

   Note: replace placeholder values

   • Create the api/.env file and add the following content:

      KC_AUTH_URL=<auth-url>
      KC_AUTH_REALM=<realm-id>
      KC_AUTH_CLIENT_ID=<client-id>
      INFRASTRUCTURE_FORM=<formId>
      NETWORK_FORM=<formId>
   

   Note: replace placeholder values

Run

3. Setup local development environment:

   Windows make is required. It can be located here: https://gnuwin32.sourceforge.net/packages/make.htm Please add the <make_home>\bin directory to the Windows path.

   To run Application in Docker cd root folder

       make run-local
   
   

Deployment

• openshift