Skip to content

Latest commit

 

History

History
111 lines (73 loc) · 3.46 KB

README.md

File metadata and controls

111 lines (73 loc) · 3.46 KB

kids-first-portal-ui

Kids First Portal

Pre-requisites

  • Node 16+
  • Docker

Get Started

Environment variables:

Running the project locally

Starting the Bastion

  • Start bastion using: igor

Starting the project

  • Install dependencies: npm install
  • Start the project: npm start

Running the USERS API locally

Running NGINX locally

Storybook

Run to install storybook submodules

git submodule init
git submodule update

Branch

Name structure is type/SKFP-[github ticker number]/description

e.g.

"fix/SKFP-23432/issue-with-..."

Supported types:

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Commit

Commit message should follow a customized conventional commits specification

Message structure is type([scope]): #[github ticker number] message

e.g.

"fix(CohortBuild): #23432 Resolve issue with ..."

"feat: #23423 Member can now do ..."

Supported types:

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Deployment

See Documentation

Acknowledgement

BrowserStack

Docker

Steps from scratch:

  1. Clone this repo
  2. Checkout branch 2.0
  3. Add a .env file with the required values at the root of the project (based on the .env.schema file)
  4. docker-compose up