Skip to content

Latest commit

 

History

History
80 lines (48 loc) · 4.19 KB

README.md

File metadata and controls

80 lines (48 loc) · 4.19 KB

logo

ng-fullstack is a yeoman generator that allows you to rapidly get started with prototyping web applications with the newest technologies available. It allows you to choose between a client app, a server app or a fullstack app. All of them simple to extend and powerful to use.

Getting Started

If you already have Node/Go setup, all you have to do is run:

$ npm install -g generator-ng-fullstack

Or, if you want to run the latest (in development) version:

$ npm install -g generator-ng-fullstack@next

Then, to create a new app, simply run:

$ yo ng-fullstack

A few questions will be shown, make sure you answer them and, there you go! Now you have the boilerplate app working.

Since some parts of the stack might be new to you, the boilerplate app is a simple TodoApp using the best approaches, separations of concerns and responsabilities - so you can see how it all works together as well as study the chosen stack. For more info, checkout the Todo App in the wiki.

Check the getting started session in the wiki for more info.

Wiki

In the wiki you'll find: pro tips, the sub-generators, FAQ, Troubleshooting, walkthroughs, tips for deployment and much more.

Chat

Do you have a doubt, want to talk about something cool or just want to chat? Join us on the gitter chat 😄

Contributing

Pull requests, helping others solving issues, improving the Wiki, among other tasks, are all valid, and more than welcome, contributions - don't hesitate.

When doing a Pull Request, make sure you target the dev branch, master is supposed to be an stable branch - the changes are merged only at the end of a version.

As for tests, run simply run npm t - it'll run both unit and acceptance tests.

Development

Branch Status Coverage Version
master Build Status Coverage Status npm version
next Build Status Coverage Status ---

Resources

Here are some links to help you understand some of the parts of the stack:

License

MIT