Apiculi

Generator for RESTfull API with CRUD operations.

[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]
[![NPM License][license-image]][license-url]

Installation

``sh
$ npm install -g apiculi
`

Quick Start

The quickest way to get started with apiculi is to utilize the executable apiculi to generate an application as shown below:

Create the app:

`bash
$ apiculi my-app && cd my-app
`

Install dependencies:

`bash
$ npm install
`

Rock and Roll

`bash
$ npm start
``

Command Line Options

This generator can also be further configured with the following command line flags.

-h, --help output usage information
-V, --version output the version number
--git add .gitignore
-f, --force force on non-empty directory
-m, --mongo set mongo connection url
-r, --redis set redis connection url

Config

After creating app structure, you will find config folder with config files in it. Take a look at the models files. There you can manage your models easily, just define your schema and name of model and Apiculi logic does a rest.

License

MIT

[npm-image]: https://img.shields.io/npm/v/apiculi.svg
[npm-url]: https://npmjs.org/package/apiculi
[downloads-image]: https://img.shields.io/npm/dm/apiculi.svg
[downloads-url]: https://npmjs.org/package/apiculi
[license-image]: https://img.shields.io/npm/l/apiculi.svg
[license-url]: https://npmjs.org/package/apiculi