https://github.com/bcgov/nr-rec-resources
Product to support managing recreation resources across the province, within the Parks & Recreation division. Focused on Rec Sites and Trails BC.
https://github.com/bcgov/nr-rec-resources
alb apigateway aurora aws cloudfront ecs gha nest node react sea
Last synced: 8 months ago
JSON representation
Product to support managing recreation resources across the province, within the Parks & Recreation division. Focused on Rec Sites and Trails BC.
- Host: GitHub
- URL: https://github.com/bcgov/nr-rec-resources
- Owner: bcgov
- License: apache-2.0
- Created: 2024-09-26T18:35:00.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-13T18:48:40.000Z (8 months ago)
- Last Synced: 2025-02-13T19:38:10.078Z (8 months ago)
- Topics: alb, apigateway, aurora, aws, cloudfront, ecs, gha, nest, node, react, sea
- Language: TypeScript
- Homepage:
- Size: 6.43 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 130
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](/LICENSE)
[](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
[](https://github.com/bcgov/nr-rec-resources/actions/workflows/main.yml)
[](https://github.com/bcgov/nr-rec-resources/actions/workflows/analysis.yml)
[](https://github.com/bcgov/nr-rec-resources/actions/workflows/scheduled.yml)
# Recreation Resource Services - RSTBC
- [Contributing](CONTRIBUTING.md)
- [Code of Conduct](CODE_OF_CONDUCT.md)
- [License](LICENSE)
- [Security](SECURITY.md)
## Table of Contents
### Project Setup
- [Local Development](#local-development)
- [Prerequisites](#prerequisites)
- [Docker Compose](#docker-compose)
- [Installing and running the application locally](#installing-and-running-the-application-locally)
- [Database](#database)
- [Backend](#backend)
- [Frontend](#frontend)
- [Generate API Client Library](#generate-api-client-library)
- [Prerequisites](#client-library-prerequisites)
- [Generate TypeScript Axios Client](#generate-typescript-axios-client)
- [Generating Prisma Schema and Client](#generating-prisma-schema-and-client)
- [Pre-commit hooks](#pre-commit-hooks)
- [Skipping pre-commit hooks](#skipping-pre-commit-hooks)
- [Running pre-commit on all files](#running-pre-commit-on-all-files)
- [Style Guide](#style-guide)
- [Schemaspy Database Schema Documentation](#schemaspy-database-schema-documentation)
### API
- [OpenAPI/Swagger Documentation](docs/open-api-swagger.md)
- [Swagger Decorators](docs/open-api-swagger.md#swagger-decorators)
- [Accessing Generated Documentation](docs/open-api-swagger.md#accessing-generated-documentation)
### CI/CD
- [CI/CD pipeline with GitHub Actions](docs/ci.md#ci-cd-pipeline-with-github-actions)
- [Docker image build and push](docs/ci.md#docker-image-build-and-push)
- [Visual Regression Testing with Happo](docs/ci.md#visual-regression-testing)
### Deployment
- [Deploying to AWS](docs/deployment.md#deploying-to-aws)
- [Manually deploying pull request to AWS](docs/deployment.md#manually-deploying-pull-request-to-aws)
- [Clearing Terraform state lock](docs/deployment.md#clearing-terraform-state-lock)
- [AWS Logging](docs/deployment.md#aws-logging)
- [Cloudwatch](docs/deployment.md#cloudwatch)
- [API logs](docs/deployment.md#api-logs)
- [Aurora RDS PostgreSQL logs](docs/deployment.md#aurora-rds-postgresql-logs)
- [Aurora RDS PostgreSQL Query Editor](docs/deployment.md#aurora-rds-postgresql-query-editor)
## Local Development
### Prerequisites
- Node.js
- npm
- Docker OR PostgreSQL 16
### Docker Compose
To run the entire application using Docker Compose, run the following commands:
```bash
git clone git@github.com:bcgov/nr-rec-resources.git
cd nr-rec-resources
docker-compose up
```
Navigate to `http://localhost:3000` in your web browser to view the application.
### Installing and running the application locally
Before starting development on this project, run `npm install` in the base
directory to install eslint and plugins to ensure linting is working correctly.
### Database
To run this on your local machine, you will need a working installation of
PostgreSQL 16.
Create an `.env` file in the `backend` directory using the example in
`backend/.env.example` as a template.
```bash
cd nr-rec-resources
make create_db
make migrate
make load_fixtures
```
or to drop, recreate, run migrations and reseed the database, ensure no
connections are open to the database then run:
```bash
make reset_db
```
### Backend
Ensure you have the `.env` file in the `backend` directory from the previous
step.
```bash
cd backend
npm install
npx prisma generate
npm run dev
```
### Frontend
Create an `.env` file in the `frontend` directory using the example in
`frontend/.env.example` as a template.
```bash
cd frontend
npm install
npm run dev
```
Navigate to `http://localhost:3000` in your web browser to view the application.
### Generate API Client Library
#### Client Library Prerequisites
Install Java Development Kit (JDK) 17:
```bash
brew install openjdk@17
```
#### Generate TypeScript Axios Client
Run the following command from the project root folder to generate the
TypeScript client library from your OpenAPI specification and run `prettier-fix`
to format the files:
```bash
npm run install-client-sdk
```
This command will:
- Generate TypeScript client code using Axios
- Use the OpenAPI spec from your local NestJS server which should be running on
port **8000**
- Output the generated code to `src/service/recreation-resource` directory
### Generating Prisma Schema and Client
When you make changes to the database schema, you will need to regenerate the
Prisma schema and client. Ensure your database is running and run the following
commands:
```bash
cd backend
npx prisma db pull # Pull the latest schema from the database
npx prisma generate # Generate the Prisma client
```
The updated Prisma schema can be viewed in `backend/prisma/schema.prisma`
## Pre-commit hooks
Pre-commit is set up to run checks for linting, formatting, and secrets.
- Install [pre-commit](https://pre-commit.com/)
- With pre-commit installed run `pre-commit install` in the root directory of
the project
- Pre-commit should now run on your staged files every time you make a commit
### Skipping pre-commit hooks
If you need to skip the pre-commit hooks for a specific commit, you can use the
`--no-verify` flag. Some developers may use this when they are making a commit
that they know will fail the pre-commit checks, but they still want to commit
the changes. This is a perfectly acceptable workflow, though there is a
pre-commit check in CI so it may be necessary to run pre-commit on all files
before putting a PR up for review if this is skipped.
```bash
git commit -m "Your commit message" --no-verify
```
### Running pre-commit on all files
Sometimes it may be necessary to run `pre-commit` on the entire project due to a
mistake or a configuration change.
```bash
pre-commit run --all-files
```
## Style Guide
Commits follow the conventions defined in the
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
specification.
## Schemaspy Database Schema Documentation
Schedule job runs every saturday and keep schema documentation upto date in
[github pages](https://bcgov.github.io/nr-rec-resources/).