ionic-conference-api

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

ionic-conference-api

★ 8 Open GitHub ↗

RESTful APIs for Ionic Conference App built with koa2

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

#RESTful APIs for Ionic Conference App

[![Build Status](https://travis-ci.org/ddellamico/ionic-conference-api.svg?branch=master)](https://travis-ci.org/ddellamico/ionic-conference-api) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT) [![Dependency Status](https://david-dm.org/ddellamico/ionic-conference-api.svg)](https://david-dm.org/ddellamico/ionic-conference-api) [![devDependency Status](https://david-dm.org/ddellamico/ionic-conference-api/dev-status.svg)](https://david-dm.org/ddellamico/ionic-conference-api#info=devDependencies)

RESTful APIs for [Ionic Conference App](https://github.com/ddellamico/ionic-conference-app) application.
The sole purpose of this app is to provide a simple oAuth2 implementation for [Ionic Conference App](https://github.com/ddellamico/ionic-conference-app).

**Api component live demo:**: https://ion-conf-api.damiendev.com

## Features
  * Koa 2 ( async/await replace generator functions) : <https://github.com/koajs/koa/tree/v2.x>
  * Simple oAuth2 password flow implementation with oauth2orize : <https://github.com/jaredhanson/oauth2orize/>
  * Docker and Docker-compose
  * ES6 support via [babel](https://babeljs.io)
  * ES6 modules ( transpiled with babel )
  * Moongoose.js (for MongoDB interaction): <http://mongoosejs.com/>
  * JSON Web Token ([JWT](http://jwt.io)) authentication

## Requirements

* [NodeJs](http://nodejs.org) >= 5.x
* [Docker](https://www.docker.com/products/docker) and [Docker compose](https://docs.docker.com/compose)

## Install

```bash
  $ git clone https://github.com/ddellamico/ionic-conference-api
  ```

Finally run `cd ionic-conference-api && docker-compose up` in the project dir to create and start the container.

The app should then be running on your docker daemon on port **3000**.

**NOTE:** [dotenv](https://github.com/motdotla/dotenv) is used to manage environment variables from a `.env` file.
  Place in root project a `.env` file and "overwrite" the default values.
  In `development` env, you can set the env variables by doing:

```
  cp .env.dev.example .env
  ```

and replace the values there.

## Documentation

API documentation is written inline and generated by [jsondoc](http://apidocjs.com/).

## Tests

```sh
$ npm test
```

## License

MIT

ionic-conference-api

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README