nyg-jam3

nyg-jam3

Jam3 project scaffold based on nyg. Used to create the basic files needed for a Jam3 project.

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

You will then be prompted with a number of questions, which will define the project. The appropriate files will then be copied to the current directory and it will install all your needed dependencies. Congratulations, you are now setup with the basis of a Jam3 project.

Prompts

What is your name? (Author)
Default: Jam3
A name used in the README.md, package.json and humans.txt.

What is your email? (Author Email)
Default: [e-mail]
An email used in the package.json and humans.txt.

Describe the project:
Default: A Jam3 project
A brief description of the project that is used at the top of the README.md.

What is your git repository? (GitHub Repository)
Default: (empty string)
The git repository used for the project, used within the package.json.

What framework will your project use?"
Default: React
The framework that this project will be based on, all necessary files and modules will be downloaded to get you up and running with the selected framework. Currently supports React, Bigwheel, or None. In the case of None, source files won't be created, but all the common development scripts will still be setup.

Would you perfer Landing/Landing.js over Landing/index.js?
Default: false
Whether file names will follow the convention of [folder name]/[folder name].js or [folder name]/index.js.

Use push states?
Default: true
Whether to use push states in the application, if false, uses hashbangs. This will setup the proper configuration in the framework and the .htaccess file.

Would you like to use ES6?
Default: true
Whether to use ES6 and babel transpilation. Sets up a .babelrc file and all necessary dependencies.

What css preprocessor will your project use?
Default: SCSS
Which css preprocessor should be setup on the project, defaults to SASS, but LESS is also an option.

Separate common npm modules into vendor.js?
Default: true
Whether to separate all npm modules into a separate vender.js file, limiting the bundle.js file to just custom code.

What backend language would you like to use?
Default: PHP
Whether to copy over backend libraries that aid development such as automatic meta tag generation and unsupported page redirection.

Choose the password to use for password protection. (leave blank to disable)
Default: (empty string)
If you want to enable password protection via .htaccess, simply type the password you would like to use and the .htaccess and .htpasswd files will be created.

Where on the server will your .htpasswd be located?
Default: /var/www
If you opted to add password protection, this will need to be set to the location of the .htpasswd file in your production environment.

Generated Project Documentation

License

MIT, see LICENSE.md for details.