generator-fiddus-server

Yeoman generator

Getting Started

What is Yeoman?

Trick question. It's not a thing. It's this guy:

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-fiddus-server from npm, run:

npm install -g generator-fiddus-server

Finally, initiate the generator:

yo fiddus-server

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, Grunt and Bower, check out the complete Getting Started Guide.

Fiddus-Server generator

This generator creates a working REST API server, on top of a Node.js/Express.js/MongoDB stack.

It comes with authentication, user management (CRUD + activation + password recovery) and some basic action logging.

The structure of the application is somewhat based on Peter Lyons express code structure for mid-sized Express projects, where files related to some specific part of application stay close together, instead of separated by function, such as in traditional MVC architectures (I'm looking at you, RoR).

Contributing

If you wish to modify the server structure itself, instead of generator stuff, please @see https://github.com/fiddus/server-template. This generator is completely based in this server template and any changes made to the template will be ported to the generator.

If you want to add functionality to the generator itself, such as further configuring the output, fell free to send PR's to this repo.

License

The MIT License (MIT)

Copyright (c) 2015 Vinicius Teixeira [e-mail]

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.