https://github.com/fkanout/notifydrive-api

RESTFull API using ES6, Notify Driver is a mobile app that allows drivers and road users to get in touch in case a parked car is either disturbing or facing an issue.
https://github.com/fkanout/notifydrive-api

koa2 microservice rabbitmq rest-api

Last synced: 5 months ago
JSON representation

RESTFull API using ES6, Notify Driver is a mobile app that allows drivers and road users to get in touch in case a parked car is either disturbing or facing an issue.

• Host: GitHub
• URL: https://github.com/fkanout/notifydrive-api
• Owner: fkanout
• License: apache-2.0
• Created: 2017-09-05T20:19:18.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2025-02-14T03:14:18.000Z (about 1 year ago)
• Last Synced: 2025-02-27T15:05:57.343Z (about 1 year ago)
• Topics: koa2, microservice, rabbitmq, rest-api
• Language: JavaScript
• Homepage:
• Size: 957 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 43
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

# NOTIFY DRIVER - API



[![codecov](https://codecov.io/gh/fkanout/NotifyDrive-API/branch/master/graph/badge.svg)](https://codecov.io/gh/fkanout/NotifyDrive-API)

[![Build Status](https://travis-ci.org/fkanout/NotifyDrive-API.svg?branch=master&style=flat)](https://travis-ci.org/fkanout/NotifyDrive-API)

[![CircleCI](https://circleci.com/gh/fkanout/NotifyDrive-API/tree/master.svg?style=shield)](https://circleci.com/gh/fkanout/NotifyDrive-API/tree/master)

[![Known Vulnerabilities](https://snyk.io/test/github/fkanout/NotifyDrive-API/badge.svg?style=flat)](https://snyk.io/test/github/fkanout/NotifyDrive-API)

[![Dependency Status](https://www.versioneye.com/user/projects/59b2e7ee0fb24f004e1a5ae9/badge.svg?style=flat)](https://www.versioneye.com/user/projects/59b2e7ee0fb24f004e1a5ae9)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

*Notify Driver is a mobile app that allows drivers and road users to get in touch in case a parked car is either disturbing or facing an issue.*

For example, a user can alert a car's owner that his car is being stolen or that he/she forgot to turn off the lights. Or, a driver can alert another driver that he/she is parked in front of his/her parking exit and that if she/he doesn't come to move it, police will be alerted within 10 minutes.

# STACK 

`Restful API using EcmaScript6`

`Node 8.x` 

`Koa2, Koa-router`

`RabbitMQ`

`Seneca microservice toolkit`

`MongoDB` Database

`Joi` Object schema description language and validator for JavaScript objects.

`Mocha` Test framework

`Chai` BDD / TDD assertion library

`Istanbul` Code coverage tool

`Docker` Software container platform

`Travis CI` Continuous integration platform

# ENV variables

`MONGO_DB_URL` DB connection URL

`MONGO_DB_URL_TEST` DB connection URL (Test DB)

`PASSPHRASE` Token signature

`GPSTOADDRESS_URL` GPS to Address microservic's URL

`GPSTOADDRESS_TASK` GPS to Address microservic's task name (inside the HTTP request's header )

`AMQP` RabbitMQ connection URL

`QUEUE` Queue name for push notification

`ENV` Environment variable (`DEV | PROD`)

`NODE_ENV` Node environment variable (`TEST, DEV`)

# Who am I

[Website](https://www.kanout.com)

[Linkedin](https://www.linkedin.com/in/faisalkanout/)