README
Yeoman Generator
GrailMy personal Holy Grail for quickly getting started with a sweet webdev environment. If you can't catch it, at least you can come close. Using/modifying it for over a year, haven't looked back.
Installation
Make sure you have Yeoman installed:
npm install -g yo
Then install the generator:
npm install -g generator-grail
Local Installation
git clone git@github.com:mustardamus/generator-grail.git
cd generator-grail
npm install
npm link
- Generate a app yo grail
mkdir appname
cd appname
yo grail
This will create a bare-bone webdev environment for a modular one page application. Check out the README.md for an app to see what you'll get and how it works.
- Extend the frontend app yo grail:extend
My personal choice in frontend libraries and frameworks, like
Vue.js, jQuery,
Semantic-UI and Socket.io
(available in combination with yo grail:server
).
Check out the README.md for extending the app to see what you'll get and how it works.
- Extend with a Node.js backend yo grail:server
Sometimes just a frontend is not enough. If you'd like to have a simple Express.js, MongoDB, Lodash and Socket.io backend to build on, run this generator.
Check out the README.md for the backend to see what you'll get and how it works.
- Extend front- and backend with registration/authentication yo grail:auth
Run this generator to have a boilerplate for basic user registration and
authentication. Note that you need to run yo grail:extend
and
yo grail:server
beforehand.
Check out the README.md for the registration/authentication to see what you'll get and how it works.
- Extend with continuously running Workers yo grail:workers
Run this generator to have a boilerplate for Workers that also have access to the config, helpers and models that the Server is using. They are called in an interval.
Check out the README.md for Workers to see what you'll get and how it works.
- Create a Client/Server Component yo grail:create
This generator quickly creates a Component for the Client (Code, Style, Template and/or Test), the Server (Initialize, Helper, Routes, Model) or a Worker. Just run it and you are prompted with the different options.