README.md

BaseProject Web

This web is built with CRA. This framework was choosen in order to avoid basic web configurations.

Check the docs.

Requirements

• Yarn
• Docker & Docker-Compose

Installation

$ git checkout develop
$ cp .env.example .env
$ yarn install

Running Locally

$ yarn start

# Stop the service
$ ctrl + c

Environment Deployment

For deployments, we are building locally and pushing the build result.

# Locally
$ git checkout {environment-branch}
$ git merge develop
$ yarn build:deploy

# From server (SSH)
$ git checkout {environment-branch}
$ yarn down
$ git pull
$ yarn up

Code Generator

In order to have a better developer experience this projects has it own code generator.

Check more about the generator lib we are using here.

# Run the generator and follow the instructions
$ yarn g

Developed by Made2.