ようこそ

Discover your new home

Wiki

For more information about the project click here

Getting Started

Clone this repo and run npm install while in the repo root directory to install project dependencies.

The following commands are available:

# start a development server:
npm run dev

# create a production build (defaults to staging environment):
npm run build

# create a production build for staging environment:
npm run build:staging

# create a production build for production environment:
npm run build:production

# start a production server:
npm run start

# typecheck TypeScript
npm run typecheck

# format with Prettier
npm run format

# check formatting with Prettier
npm run format:check

# check for issues with ESLint
npm run lint

# fix linting issues with ESLint
npm run lint-fix

# run Enzyme unit tests
npm run test:unit:components

# run Firestore security rules unit tests
npm run test:unit:firestore

# run Cypress integration tests - will open new window with GUI interface for debug. Manually select yosoko > index.spec.js test suit
npm run cypress

# run Cypress integration tests in headless mode.
npm run cypress:all

Note that Firestore security rules unit tests must be ran with the Firebase emulator installed and running for Firestore. One quick way is to run npx -y firebase-tools emulators:exec --only firestore "npm run test:unit:firestore" which will install the emulator (if not already installed) and run the tests. See the Firebase documentation for more details.

Preview

Yōkoso is deployed to separate production and staging environments, based off the main and develop branches respectively.

Production:

• https://d1qhziiies987t.cloudfront.net/

Staging:

• https://d2l3ad90rail6x.cloudfront.net/