OLYMPUS

About

• Olympus package for using olympus endpoint. All are properly & fully tested.

Getting Started

Technologies · Installations · Tests · Author

Technologies Used

• ESLint - A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript.
• Jest - Jest is a JavaScript testing framework maintained by Facebook, Inc. designed and built by Christoph Nakazawa with a focus on simplicity and support for large web applications.
• Airbnb style guide was followed.
• TypeScript

Installations

Getting started

• You need to have Node and NPM installed on your computer.
• Installing Node - automatically comes with npm.

Setup

• Installing the project dependencies

  Run the command below

  $ npm i awabah-olympus

Usage

$ const { Olympus } = require('awabah-olympus');
$ const  olympus = new Olympus('secret_key');

Components

• Authentication
  • login user

    $ olympus.authentication.login(data)

  • register user

    $ olympus.authentication.register(data)

Test

run the command below

$ npm test

Author

• Tina