Code Monkey home page Code Monkey logo

boilerplate-frontend's Introduction

πŸ’€ Scaffolding React typescript

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

πŸ” Requirements

Dependencies Description
node-version Javascript Runtime
sam-version AWS SAM CLI
docker-version Virtualization containers
terraform-version Terraform
terragrunt-version Wrapper for Terraform

πŸ”¨ Project setup

  1. To clone repository you need to have git installed:
git clone [email protected]:GrooveCommunity/boilerplate-frontend.git
  1. Enter repository
cd boilerplate-frontend
  1. To install dependencies you need to have NodeJS installed:
npm install

πŸ“‘ Available Scripts

In the project directory, you can run:

Server for development

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.

Build

Builds the app for production to the build folder.

npm run build

See the section about deployment for more information.

Get coverage

npm run coverage

Check linter

npm run lint

Unit tests

Launches the test runner in the interactive watch mode.

npm run test

See the section about running tests for more information.

⬆️ Deploy locally other environment

To deploy locally you need run build before proceed.

  1. To create the s3 bucket use this, you need terragrunt terragrunt installed:
terragrunt apply --terragrunt-working-dir iac

To learn more Terragrunt.

  1. Now deploy files using to aws using Node to run the AWS CLI with this command
npm run deploy

πŸ”₯ Destroy environment locally

  1. Clear a s3 bucket using Node to run AWS CLI with this command
npm run remove
  1. Now destroy s3 bucket with terraform
terragrunt destroy --terragrunt-working-dir iac

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Contributing guide

To contribute to the project try to read the CONTRIBUTING.md.

πŸ’ͺ Dev Team

This project exists thanks to all these people.

Marcos

boilerplate-frontend's People

Contributors

codermarcos avatar

Stargazers

Victor França Lopes avatar

Watchers

Eduardo Dicarte avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.