Fork me on GitHub

ninit

A community-driven Node.js module bootstrapper with a focus on sharing personal best practices in organizing codebases.

About

When I'm talking to developers who are working with Node.js for the first time they are complaining that creating a maintainable structure for their application / module represents one of the hardest aspects. Yes, there are many ways to structure a Node.js module. Every developer has its own style / flavor. That is great! This flexibility makes this community so unbelievable unique. ninit's aim is to provide a platform on which every developer can publish her personal application / module template in order to share best practices and therefore help to support starters but also the evolution of the Node.js ecosystem in general. So this project could be all about sharing experiences regarding this topic.

But even if you don't have any templates to share, no worries, ninit brings the possibility to generate a fresh structure out of the available templates to bootstrap your next project. Enough words. Let's dive into this thingy.

Contributing

The goal of this project is to have a discussion about different views on organizing codebases in Node.js and to provide a platform where all of those organizational patterns can be discussed, archived and used for bootstrapping. So open up your editor and publish your favorite module structure :)

Help your community and send your favorite module structure

Available templates

These are the available templates. You can add templates if your flavor is missing.

Installation

So this was the part of the contribution. As I said before there is also a generator which can bootstrap a new project out of a template.

So the installation is straightforward:

npm install -g ninit
                

Usage

After the installation you are able to generate a module by a given template. The execution sequence is:

ninit <template-name>
                

For example:

ninit akoenig.library