SpaceTitle

Brief Overview

TABLE OF CONTENTS

1. Project Description
2. Installation
3. Running & Testing Scripts
4. Copyright And Licensing

Project Description

• What,
• Why,
• Challenges,
• Learnings,
• Upcoming features.

Installation

Prerequisites/Setup

• git
• NodeJS v18 - Recommend installing nvm to manage node install
• npm
• VSCode or an IDE of your choice

For developers. Create a .env file with the below details

• REACT_APP_VERSION=GITHUB_RUN_NUMBER (added upon build in GitHub action in dev and prod)
• REACT_APP_STAGE=LOCAL
• REACT_APP_CHALLENGE_BASE_URL=https://3q82hpcgp1.execute-api.ap-southeast-2.amazonaws.com/prod
• REACT_APP_CHALLENGE_API_KEY=(API key here)

Running and Testing scripts

Install

• npm i - to install packages/dependencies

Run

• npm run start - to run project on port 3000

• npm run lint - to lint your files using ESLint

• npm run lint:fix - fix problems using ESLint

Unit tests

• npm run test - to run jest tests with watch
• npm run test:coverage - to run jest tests with coverage

End-to-end tests

Ensure application is started before running E2E tests In cypress.config.ts find REPLACE_ME_WITH_BASE_URL and replace it with your localhost URL and REPLACE_ME_WITH_END_POINT_URL_HERE with backend API

• npm run e2e - to run cypress e2e tests with UI
• npm run e2e:cli - to run cypress e2e tests with no UI

Production build script

• npm run build - build your project

Copyright And Licensing