nyg-jam3

Jam3 Generator

Jam3 Frontend App Generator with no build configuration and no prompts.

• Usage
• Developer Contribution Guide – Read first if you are a developer
• Main scripts – Running scripts
• Developer Guide – How to develop apps bootstrapped with the generator

Usage

The nyg generator is designed to function similar to yeoman. To get it running, simply follow these steps:

npm i nyg -g
npm i nyg-jam3 -g
cd your-project-directory
nyg nyg-jam3

Developer Contribution Guide

Contribute with boilerplate

• Go to /templates
• Run npm i
• Ready to go, everything is inside that folder

Contribute with the generation

• Review /index.js, everything is there

If you are looking to contribute to the generator it is important to read the Developer Contribution Guide

Main scripts

In the template, you can run:

npm start

Runs the app in development mode.
Open http://localhost:3000 to view it in the browser.

You will automatically see the changes in your app after modifying your code, we are using HMR. You will also see build errors and warnings in the console as well as the browser.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the random hash strings in order to avoid server-side caching. (example: main.df8fsdfs.js)
By default, it also includes a service worker so that your app loads from local cache on future visits.

Before creating the production build, make sure removing everything you don't need. There are many samples in the generator to avoid prompting at the beginning of the project.

Your app is ready to be deployed.

npm test

Runs the test watcher in an interactive mode.
By default, it runs tests on the files that have changed since the last commit.

Read more about testing.

npm run release

To release new versions we are using standard-version.

Steps:

• When PRs/commits land to your master branch, select the Squash and Merge option.
• Add a title and body that follows the Conventional Commits Specification.
• Run $ git checkout master; git pull origin master
• Run $ npm run release
• Run $ git push --follow-tags origin master && npm publish

Developer Guide

We are using react-scripts as a base. You can checkout their User Guide. Everything here applies to the generator.

You can check out our Developer Guides to know more about the features and customizations.