-
Clone this repo
-
Install dependencies by running:
npm install
-
Run the frontend application:
option 1:npm start
option 2 - using docker-compose:docker-compose up -d --build
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
npm test
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Test for linting and prettier issues, as a precaution, use before pushing any commit to make sure build succeeds on Github Actions.
npm run lint-tests
To fix linting and prettier issues use:
npm run lint-fixes
npm run css-build
Using the last command compiles the scss file App.scss into its processed form i.e. App.css. Learn more about scss at:
https://sass-lang.com/documentation/syntax
NOTE : This will over ride any changes done in App.css and not contained in App.scss, hence, always use App.scss and then compile it into App.css before pushing changes.
One possibility is adding a watcher node package that automatically compiles the scss file into css whenever a change is made.
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.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.