README.md

MateriaBrasil - Web

Installation

Dependencies

yarn

Clone the repository

$ git clone [email protected]:MateriaBrasil/materiabrasil-web.git
$ cd materiabrasil-web

Install dependencies

$ yarn

Set the env vars

$ cp .env.sample .env

Ask a colleague for the values.

Run the server

$ yarn start

You can check that it worked by browsing localhost:3000.

Tests

Running tests

$ yarn test

Running tests with coverage report

$ yarn test --coverage

The coverage will be available on the coverage/ folder. Open coverage/lcov-report/index.html on your browser to see details.

Running the linter

$ yarn lint

Deployment

Staging

Merging to the master branch will automatically deploy to Netlify.

Production

A manual deploy must be triggered on materiamundi Netlify after merging to the master branch.