nyg-static-jam3
v1.0.0
Published
Jam3 frontend static project scaffold generator based on nyg
Downloads
8
Readme
Jam3 Static Generator
Jam3 Static Frontend App Generator with no build configuration and no prompts.
- Usage
- Developer Contribution Guide – Read first if you are a developer
- Developer Guide – How to develop apps bootstrapped with the generator
- Main scripts – Running scripts
Usage
To create a new project based on the generator there are a few ways:
- Using the generator npm package.
- Generate the output template.
- Copy and paste and update some values in the template.
Using the npm package
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-static-jam3 -g
cd your-project-directory
nyg nyg-static-jam3
React Static
See REACT_STATIC.md for more details on how React Static is intergrated with this generator
Generate the output template
Do this if you have the source code and want to generate a version ready to be used in a project.
- Make sure you are in the root of the generator
- Run
npm test
- Copy/Paste the files in
/test/output/
into your project folder. - Update the
README.md
andpackage.json
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 with the generator is important to read the Developer Contribution Guide
Developer Guide
We are using react-static
as a base; you can checkout their Documentation.
You can checkout our Developer Guides to know more about the features and customizations.
Main scripts
TBF
Publishing to production
TBF