search

bcgov / NewJobSurveyAdmin

The New Job Survey Admin tool will assist BC Stats in administering the BCPS New Job Survey.
https://www2.gov.bc.ca/gov/content/data/statistics/government/employee-research/new-job-survey
Apache License 2.0
1 stars 1 forks source link
bcstats citz dotnet-core openshift react

readme

NewJobSurveyAdmin

The New Job Survey Admin tool will assist BC Stats in administering the BCPS New Job Survey.

Lifecycle:Stable

Development tasks

Running a development environment

Prerequisites

  1. Ensure the .NET Core SDK 3.1.20 (on the linked page, scroll down and expand the 3.1.2 disclosure arrow to find the correct SDK) is installed.
  2. Ensure you have the .NET EF Core CLI installed: dotnet tool install dotnet-ef --version 6.0.0
  3. Ensure the .NET Core HTTPS development certificate is trusted.
  4. Install Postgres and create a database named njsa.
  5. Check out the code from this repository.

NB. To be fully functional, the application should be run in conjunction with the CallWeb API. The code for the CallWeb API is not publicly available. Please reach out to the project team for access. However, the project will still build and run without the CallWeb API.

Install EF Core dependencies

dotnet tool install dotnet-ef --version 6.0.0 dotnet add package Microsoft.EntityFrameworkCore --version 3.1.4 dotnet add package Microsoft.EntityFrameworkCore.Design --version 3.1.4

Config + secret settings

The application uses two appsettings.json files, one in the /config directory and one in /secret. This mirrors how the application gets deployed to OpenShift. /config/appsettings.json contains non-sensitive configuration for the application, while /secret/appsettings.json contains configuration that should not readily visible.

See also the comments in Program.cs about how the files get resolved when the application is deployed to OpenShift.

To get set up:

  1. Copy the contents of /config/appsettings.config-template.json into a new file, /config/appsettings.json, and update the values as appropriate.

  2. Do the same with /secret/appsettings.secret-template.json, copying it into /secret/appsettings.json.

  3. We also need to set up the frontend environment. In the /ClientApp directory, copy env.example into .env, and update the values as appropriate.

Run migrations

  1. From the root project directory, run dotnet ef database update. This will run the migrations and set up your development database. ENSURE THAT dotnet add package Microsoft.EntityFrameworkCore --version 3.1.4 dotnet add package Microsoft.EntityFrameworkCore.design --version 3.1.4

    Note that the database will be seeded automatically when the application is started.

Start the API

  1. Open the root code directory in Visual Studio Code. You may be prompted to add required assets and/or resolve dependencies; do so.
  2. While in Visual Studio Code, press CTRL + F5 to launch the API.
  3. Test that the API is running correctly by checking the HealthStatus. If the project is running at the default location and port: curl http://localhost:5050/api/HealthStatus/Status.

Install frontend dependencies

  1. From the /ClientApp directory run yarn install.

Start the frontend

  1. Still in the /ClientApp directory, run yarn start to launch the front-end. You should see the application open in a new browser.

Quick database reset (dev ONLY)

This command will quickly drop the database, delete migrations, create an initial migration, and update the database.

dotnet ef database drop --force;rm -rf Migrations/*.cs;dotnet ef migrations add InitialCreate;dotnet ef database update