miguelmartinpas / martin-app

Overview

Showcase App with React

Setup

Clone project

git clone https://github.com/miguelmartinpas/martin-app.git

Install dependencies (node v10.16.2 is minimum requirement)

npm install

Run locally

Run with dev environmet

npm run start:dev

Run with prod environment

npm run start

ir will run in http://localhst:8080

Deploy

npm run build

dist folder will contain code ready to be used

Github workflow

Github workflow is configure to run:

• lint
• test:coverage
• deploy coverage in coveralls (3 party librarie)
• deploy app in github pages

check it on: https://github.com/miguelmartinpas/martin-app/actions

Github pages deploy

github workflow deploy the app in https://miguelmartinpas.github.io/martin-app/

Test

It runs UT with Jest and Enzyme

npm run test

Coverage

npm run test:coverage

You can check Coverage info in: https://coveralls.io/github/miguelmartinpas/martin-app?branch=main

Lint & format

It checks code with eslint and prettier

npm run lint

npm run format