readme.md

BIND React Typescript boilerplate

Minimalistic and flexible React boilerplate.

Table of contents

1. Requirements
2. Setup
3. Building and running
4. Server
5. Testing

Requirements

• GIT
• NVM - node version manager
• Prettier - code formatter for VS Code
• ESLint - linter for VS Code

Setup

$ git clone https://github.com/BindCreative/react-boilerplate MyProject
$ cd MyProject
$ nvm use                   # Sets correct node version
$ yarn                      # Installs dependencies

Building and running

$ yarn build:dev            # Development build
$ yarn build:prod           # Production build

Server

Built-in express server for development and production.

$ cd server                 # Navigate to server's subdirectory
$ yarn                      # Install dependencies
$ yarn start:dev            # Sart dev server with HMR
$ yarn start:prod           # Sart production server with SSR

Testing

Runs supplied tests with Jest

$ yarn test                 # Run all tests