README
Uniform
A Yeoman generator for building full stack data capture forms
Installation
npm install -g generator-uniform
This will scaffold a full stack application built with the following:
- Nodejs
- Express
- MongoDB
- Handlebars
- jQuery
- Underscore
- Gulp
- Browserify
Usage
Simply create a uniform.json
config file in the intended directory and and run:
yo uniform
Then confirm/enter the location of your uniform.json
file
What's the name of your config file? (uniform.json)
An example uniform.json
file:
{
"appName": "my-app",
"description" : "a description goes here",
"gitRepo": "https://github.com/christill/generator-uniform.git",
"author" : "Chris Till",
"fields" : [
{
"name" : "firstname",
"type" : "Text",
"validators" : [
"required"
]
},
{
"name" : "lastname",
"type" : "Text",
"validators" : [
"required"
]
},
{
"name" : "email",
"type" : "Text",
"validators" : [
"required",
"email"
]
}
]
}
Once the project has been created, cd into the root directory and run:
gulp
Then visit localhost:3000
in your browser and you are good to go!
Validation
The validation uses powmedia/backbone-forms. Please see docs here: https://github.com/powmedia/backbone-forms
License
Copyright (c) 2015 Chris Till
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.