Boilerplate - Front End is a microservice that provides crew register, used to create trips and select members.
This project uses react-scripts with cra to build a static frontend using React deploying to AWS S3.
Table of contents
Dependencies | Description |
---|---|
Javascript Runtime | |
AWS SAM CLI | |
Virtualization containers | |
Terraform | |
Wrapper for Terraform |
- To clone repository you need to have git installed:
git clone [email protected]:GrooveCommunity/boilerplate-frontend.git
- Enter repository
cd boilerplate-frontend
- To install dependencies you need to have NodeJS installed:
npm install
In the project directory, you can run:
Runs the app in the development mode this server compiles and hot-reloads with linter locally:
npm start
Open http://localhost:3000 to view it in the browser.
If you want works on style you need start the styles too.
Builds the app for production to the build
folder.
npm run build
See the section about deployment for more information.
npm run coverage
npm run lint
Launches the test runner in the interactive watch mode.
npm run test
See the section about running tests for more information.
To deploy locally you need run build before proceed.
- To create the s3 bucket use this, you need terragrunt terragrunt installed:
terragrunt apply --terragrunt-working-dir iac
To learn more Terragrunt.
- Now deploy files using to aws using Node to run the AWS CLI with this command
npm run deploy
- Clear a s3 bucket using Node to run AWS CLI with this command
npm run remove
- Now destroy s3 bucket with terraform
terragrunt destroy --terragrunt-working-dir iac
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
To contribute to the project try to read the CONTRIBUTING.md.
This project exists thanks to all these people.