Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 2.2 KB

README.md

File metadata and controls

61 lines (40 loc) · 2.2 KB
Raw

#Packit Front End Interface is built with React library

Requirements

Node 18.

Available Scripts

App can be started in the project directory when you run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console. \

To see a working app you will need to run dependencies. From the root directory:

  1. ./scripts/run-dependencies
  2. ./api/scripts/run OR ./api/gradlew -p api :app:bootRun

npm test

Launches the test runner in the interactive watch mode. Excludes integration tests.
See the section about running tests for more information.

npm run integration-test

Launches the test runner in the interactive watch mode, running only integration tests.
Dependencies must be running:

  1. ./scripts/run-dependencies
  2. ./api/scripts/run

npm run lint or npm run lint:fix

Launches eslint, see eslint for more information.

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.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Building a docker image

The app is containerised into an image based on nginx. Note that in deployment this will be proxied, so no security configuration is required here.

  1. ./app/scripts/build builds a docker image.
  2. ./app/scripts/build-and-push builds and pushes an image to dockerhub. This script is run on CI.
  3. ./app/scripts/run runs a built image with the current branch name.

Mock Service Worker MSW

MSW is currently used to mock API calls in tests. It is configured in src/setupTests.js. However, this can be used as a worker and be able to be if mocking of api is needed whilst development. Eg. if the api is not ready but you want to test the front end with that contract.