tbrandle/portfolio-react

Bowtie React + Recompose Starter Kit

Quick Start

Run full setup

make setup

Start service(s)

make start

Full rebuild

make rebuild

Contents

• Getting Started
  • Requirements
  • Installation
  • Usage
• Testing
  • Linting
  • Unit Tests
• Advanced
  • Local Environment

Getting Started

Requirements

• Install npm >= 6.2.0
• If you already have npm and Node.js globaly installed, you can run this command to upgrade to the latest stable version: npm install -g npm@latest

Installation

• Install git pre-push hook

ln -s ../../bin/pre-push .git/hooks

• Install node_modules (using npm)

npm install

Usage

• Start the React App

npm start

• Visit local instance

Testing

Linting

• Just lint the code and show warnings

npm run lint

• Lint code and attempt to fix simple issues

npm run lint:fix

Unit Tests

• Run ReactJS test suite (interactive)

npm test

• Run ReactJS test suite (CI mode - not interactive)

CI=true app npm test

Advanced

Local Environment

• Create file .env.development.local, add entries to customize local dev