https://github.com/marekhakala/addressbook-api

The address book is an address book web API application for SPA and mobile applications.
https://github.com/marekhakala/addressbook-api

babeljs chai express-jwt expressjs javascript mocha mongodb mongoose nodejs passportjs postgresql swagger swagger-ui

Last synced: 6 days ago
JSON representation

The address book is an address book web API application for SPA and mobile applications.

• Host: GitHub
• URL: https://github.com/marekhakala/addressbook-api
• Owner: marekhakala
• License: apache-2.0
• Created: 2017-10-27T11:38:08.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-10-27T11:48:46.000Z (about 7 years ago)
• Last Synced: 2024-11-16T05:41:57.654Z (2 months ago)
• Topics: babeljs, chai, express-jwt, expressjs, javascript, mocha, mongodb, mongoose, nodejs, passportjs, postgresql, swagger, swagger-ui
• Language: JavaScript
• Homepage:
• Size: 146 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        

# Address Book API v1.0.0

![AddressBookAPI logo](images/addressbookapi.png)

The address book is an address book web API application for SPA and mobile applications.

## Requirements

* Npm / Yarn

* Node.JS

* Express.JS

* MongoDB

## Installation

* Install yarn package manager `npm install yarn`

* Install all necessary npm packages `yarn`

## Setup

* Setup config file `cp ./config/env.json.sample ./config/env.json && vim ./config/env.json`

* Download and save Google Service Account Key into `./config/serviceAccountKey.json`

* Setup and seed database tables `yarn run seed`

## Run application - development

* `yarn run dev`

## Run application - testing

* `yarn run test`

## Libraries

 * [Node.JS](https://nodejs.org/en/) - Node.js JavaScript runtime

 * [Express.JS](http://expressjs.com/) - Fast, unopinionated, minimalist web framework

 * [Express.JS JWT](https://github.com/auth0/express-jwt) - JWT authentication middleware

 * [MongoDB](https://www.mongodb.com/) - MongoDB is a free and open-source cross-platform document-oriented database program

 * [Mongoose](http://mongoosejs.com/) - Mongoose MongoDB ODM

 * [Passport](http://passportjs.org/) - Simple, unobtrusive authentication for Node.js

 * [Swagger](https://swagger.io/) - Tools for designing and building Swagger-compliant APIs entirely in Node.js

 * [Swagger UI](https://swagger.io/swagger-ui/) - Middleware for your express app to serve the Swagger UI bound to your Swagger document

 * [Chai](http://chaijs.com/) - Chai is a BDD / TDD assertion library for node

 * [Mocha](https://mochajs.org/) - Simple, flexible, fun test framework

# License - Apache License, Version 2.0

```

# (C) Copyright 2017 by Marek Hakala 

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

#

# http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

#    limitations under the License.

```