Datapunt React project generator

Datapunt/City Data flavoured Yeoman react-boilerplate generator.

Introduction

Use this Yeoman generator to set up a new project, based on react-boilerplate.

The generator takes care of:

• cloning (the latest tag of) the react-boilerplate repository
• replacing properties and values in package.json, setting constants values and preparing Jenkinsfile
• adding necessary dependencies
• (optionally) installing all dependencies
• (optionally) pushing the initial commit

Requirements

• npm >=5
• node >=8

Has NOT been tested on Windows.

Installation

Install Yeoman

$ npm install -g yo

a. Clone this repository

After cloning, cd into the folder the repository is cloned in and run:

$ npm link

This will create a global NPM package and you will be able to run the generator from any folder.

b. Install as global NPM package

$ npm i -g generator-amsterdam-react-boilerplate

c. Find through Yeoman CLI

Run

$ yo

and select Install a generator. Type amsterdam-react-boilerplate and select the match.

Running

From the command line, run

$ yo amsterdam-react-boilerplate

or

$ yo

and select Amsterdam React Boilerplate.

Installation steps

1. Github user and repository name

Press <Enter> or type 'Y' to enter repository details. The repository name and Github user name will be used to set the Git remote. Press 'n' to skip.

2. Project parameters

3. Jenkinsfile parameters

4. PWA parameters

HTTPS in development

react-boilerplate doens't offer running the dev environment in https. The Datapunt React project generator, however, does. Setting HTTPS as environment variable will start the Express server with a self-signed certificate.

$ HTTPS=true npm run start