Skip to content

Commit

Permalink
Release 0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Ugo committed Jan 3, 2021
1 parent c4912d0 commit bf01cc5
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 4 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# generator-digga [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage percentage][coveralls-image]][coveralls-url]

A scaffold for REST API
A scaffold for a Node.js REST API

## Getting started

First, install [Yeoman](http://yeoman.io) and generator-digga using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).

Node v10 or above is required.

```bash
npm install -g yo
npm install -g generator-digga
Expand All @@ -19,13 +21,30 @@ yo digga

"Yo Digga" is the Northern German way to say "Hi bro". The word is derived from the German word Dicker, which, in this context, means close friend.

### Features
## Features



All the applications generated are coming with those perks:
- Express server
- Express Router
- Body parser
- Cors
- Travis CI
- Prettier custom rules for linting
- Axios
- Router module

Further, it is possible to include additional capability as described below:

### Options

- Bootrap with or without DB, including:
- Boostrap with or without database. It currently supports:
- Mongo
- More coming soon ...
- Add external API boilerplate
- Open Weather
- Auth0
- More coming soon...

## Getting To Know Yeoman
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "generator-digga",
"version": "0.2.0",
"version": "0.3.0",
"description": "A scaffold for REST API",
"homepage": "",
"author": {
Expand Down

0 comments on commit bf01cc5

Please sign in to comment.