Skip to content
This repository has been archived by the owner on Sep 16, 2024. It is now read-only.

Latest commit

 

History

History
73 lines (54 loc) · 7.07 KB

README.md

File metadata and controls

73 lines (54 loc) · 7.07 KB

MIT License Lifecycle

Merge Analysis Scheduled

Frontend (JavaScript/TypeScript)

Bugs Code Smells Coverage Duplicated Lines Maintainability Rating Reliability Rating Security Rating Technical Debt Vulnerabilities

Backend (JavaScript/TypeScript)

Bugs Code Smells Coverage Duplicated Lines Maintainability Rating Reliability Rating Security Rating Technical Debt Vulnerabilities

Welcome to the Quackstack Team Capstone Project 🚀

Our Mission

We're embarking on a journey to develop a mobile-first, intuitive, and modern web application inspired by the BC Government NMP Calculator (https://nmp.apps.nrs.gov.bc.ca/). Our intent is to make a Minimum Viable Product (MVP) based on the current NMP Calculator.

Our goal is to leverage technologies we're comfortable with, such as Postgres, Express, React, and Node (**PERN), while also exploring new tools like OpenShift, Progressive Web Apps, GitHub Actions, Docker and more.

This project is not just about building, it's a learning journey!

The Quackstack Crew 👥

Proudly Sponsored By the Sustainment Team

We're honored to receive support from British Columbia's Natural Resources Sustainment Team. A big thank you to them for making this project possible!

Repository Details

This repository was bootstrapped using the Quickstart for OpenShift (https://github.com/bcgov/quickstart-openshift).

Environment Variables

Here's a quick rundown of the environment variables we'll be using:

Key Example Description
API_HOST 'localhost' Determines Express the hosting environment.
API_PORT '3000' Specifies the host API port.
POSTGRES_USER 'dbUsr' PostgreSQL username for database connections.
POSTGRES_PASSWORD 'useASafePasswd' PostgreSQL password for database connections.
POSTGRES_DATABASE 'dbName' Name of the PostgreSQL database to connect to.
POSTGRES_HOST 'localhost:1234' Address of the PostgreSQL host.
POSTGRES_PORT '1234' Port where PostgreSQL is exposed.
PGADMIN_DEFAULT_EMAIL '[email protected]' Email for logging into the pgAdmin interface.
PGADMIN_DEFAULT_PASSWORD 'useASafePasswd' Password for accessing the pgAdmin interface.
VITE_HOST localhost Determines Vite hosting environment.
VITE_PORT 5173 Specified the host vite port.
VITE_BACKEND_URL localhost:3000/api Specifies the backend root endpoint vite should use.