Add some information here about this application
This is a react project written in typescript, and bundled via webpack. Css styling can be imported directly in component files to apply component styling. Continuous integration / deployment is handled with Github actions.
- See here for getting started with React
- See here for getting started with Typescript
- See here for help with webpack
- See here for information on github actions
npm install
npm start
docker-compose up
Application will be served from localhost:8080.
In both cases the application will support hot reloading on changes to the source code.
npm test
npm run lint
Continuous integration checks are run via Github actions. On each commit there run checks for:
- Unit test failures
- Lint errors
The application is deployed to the corresponding Github pages site of this repository (https://[owner].github.io/[repository])
The application uses Github actions to deploy the code. When a commit is pushed to master the deployment workflow is triggered, and will deploy the site.
For deploying a specific branch, outside of the continuous deployment workflow (for exaple when wanting to test a specific feature live) you can trigger the manual deployment workflow. Go to Actions > Manual Deployment > Run Workflow, and select the branch you want to deploy from the dropdown.