React Boilerplate

A Nord Software project.

Why do I want this?

As you probably know, there are numerous boilerplates available for React, so you might be wondering why you would want to use ours. Most of the boilerplate projects come with a lot of code that you rarely need. Our boilerplate was bootstrapped with Create React App and provides you with a great starting point for any React project with as few lines of code as possible, especially if you want to use Flowtype.

What do I need to get started?

• Node (version 6 or later)
• Yarn

What's in the box?

• Flowtype Type checker
• React User interface components
• Redux Predictable state container
• Lodash Utility library
• PostCSS CSS transformer
• Babel JavaScript transpiler
• ESLint JavaScript Linter
• Stylelint CSS Linter
• Webpack Module bundler
• Jest Testing solution

How do I use this?

You can find our documentation here.

Usage

Create project

Install create-project and create your project.

yarn global add create-project
create-project my-project nordsoftware/react-boilerplate && cd my-project

Install dependencies

Install the project dependencies using Yarn.

yarn

Create the environment

Create your environment by copying the example environment.

cp .env.example .env

Development server

You can start the development server with the start script.

yarn start

Distribution build

You can compile the distribution build with the build script.

yarn build

Test

Test suite

You can run the test suite with the test script.

yarn test

License

MIT