Skip to content

Latest commit

 

History

History
110 lines (80 loc) · 5.92 KB

README.md

File metadata and controls

110 lines (80 loc) · 5.92 KB
Raw

CARE Logo

Our goal is to continuously improve the quality and accessibility of public healthcare services using digital tools.

🚀 Staging Deploy

Auto deployed to care.ohc.network for develop branch. All pull requests have preview builds powered by Netlify.

Storybook Quality Gate Status Code scanning - action OSSAR Cypress Tests Staging Release Production Release Codacy Badge CircleCI Maintainability

Getting started

  • 💬 Comment on the issue if you are willing to take it up, and link the pull request with the issue.
  • 🏷️ Tag @coronasafe/code-reviewers for faster resolution.
  • 📸 Attach screenshots in the pull requests showing the changes made in the UI.

Install the required dependencies

npm install --legacy-peer-deps

🏃 Run the app in development mode

npm run dev

Once the development server has started, open localhost:4000 in your browser. The page will be automatically reloaded when you make edits and save. You will also see any lint errors in the console.

🔑 Staging API Credentials

Authenticate to staging API with any of the following credentials

- username: dev-districtadmin
  password: Coronasafe@123
  role: District Admin

- username: staffdev
  password: Coronasafe@123
  role: Staff

- username: doctordev
  password: Coronasafe@123
  role: Doctor

🏷️ Make use labels to update the PR/issue status

  • Mark your PRs as work-in-progress if it's still being worked on.
  • Once you have solved the related issue, mark your PR with need testing and need review labels.
  • When you’re making a PR with lots of code changes that affects multiple functionalities, or is likely to break, make sure you tag it with Major Code Change label.

🧪 Run cypress tests

Ensure that the development server is running and then run the cypress tests in either of the ways described below.

$ npm run cypress:run        # To run all tests in headless mode.
$ npm run cypress:run:gui    # To run all tests in headed mode.
$ npm run cypress:open       # To debug and run tests individually.
  • Failed test screenshots are saved in cypress/screenshots
  • All test videos are saved in cypress/videos

📖 Documentations

🚀 Production

Build the app for production

npm run build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

Start a production http-server

npm run preview

Starts a production http-server in local to run the project with Service worker. The build is minified and the filenames include the hashes.

🚀 Your app is ready to be deployed!