Quick Start

Get started with Isthmus, build and development commands

Getting Started

To get started, make sure you have Yarn installed on your computer. For installation instructions go here.

First, clone the repo to your desired location: git clone https://github.com/mbforr/isthmus-react.git

Them move into the Isthmus folder: cd isthmus-react

To configure all the required packages simply run Yarn: yarn

This should install all the necessary packages and you should be ready to go!

Starting Isthmus

To get Isthmus started and to begin developing your application you can run yarn run dev

This will start a local server running at http://localhost:8080 (or another port if you have a server running at this port already). This will also open another window at http://localhost:9000 which is a Webpack Bundle Analyzer to see the size of the Webpack bundle and associated packages.

This will open your development environment and includes hot reloading, which will refresh the page after a change has been saved.

If you are new to using Yarn and creating a React based project you can check out this overview.

Other Commands

• To run a simple build use yarn run build

• To run a complete production build with production minified .js files use yarn run prod

• To start a server to view build or production files use yarn run start

A complete production workflow would use yarn run prod and then yarn run start as the command for the server to start the application once it has been deployed.

Coming soon yarn run test