apiculi

Generator for RESTfull API with CRUD operations.

Usage no npm install needed!

<script type="module">
  import apiculi from 'https://cdn.skypack.dev/apiculi';
</script>

README

Apiculi

Generator for RESTfull API with CRUD operations.

NPM Version NPM Downloads NPM License

Installation

$ 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:

$ apiculi my-app && cd my-app

Install dependencies:

$ npm install

Rock and Roll

$ 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 <url>  set mongo connection url
-r, --redis <url>  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