generator-simple-js v1.0.0

generator-simple-js

Generates the basic structure for a simple development environment using Gulp and browserSync. Also, may or may not include Bootstrap and SASS.

Installation

First, install Yeoman and generator-simple-js using npm (we assume you have pre-installed node.js and Gulp.js).

npm install -g gulp
npm install -g yo
npm install -g generator-simple-js

Then generate your new project:

yo simple-js

What do you get?

Scaffold the next project directory structure:

.
├── gulpfile.js
├── package.json
└── src
    ├── assets
    ├── css
    ├── index.html
    ├── js
    └── scss
        └── styles.scss

What's next?

Once the project has been created you need to go to the project folder by typing in the terminal cd project-folder. Inside, you'll need to run the next command:

gulp

That command by itself will add the required CSS and JS files to the proper folders and also will launch the project in your default browser, so you can comfortably start coding and each change made in any JS, CSS/SASS, HTML file, the browser will reload with the new changes.

If you want to add more capabilities to your project, feel free to check on Gulp.js documentation.

Getting To Know Yeoman

• Yeoman has a heart of gold.
• Yeoman is a person with feelings and opinions, but is very easy to work with.
• Yeoman can be too opinionated at times but is easily convinced not to be.
• Feel free to learn more about Yeoman.

Contributing

I'm pretty new to the Open Source community, so, every contribution will be more than helpful to me and to the project, too.

I've created a template for pull requests, but if someone out there has any suggestion on improve template for the template (😆), please help on it, too.

License

MIT © Alonso Vazquez