Skip to content
This repository has been archived by the owner on Sep 25, 2020. It is now read-only.

Latest commit

 

History

History
55 lines (41 loc) · 2.23 KB

README.md

File metadata and controls

55 lines (41 loc) · 2.23 KB

SensCritique Logo

SensCritique API Build Status Dependency Status Code Climate TypeScript Open Source Love

An unofficial API for SensCritique

This is a wrapper over the API used by SensCritique in their mobile applications.

Disclaimer

Neither I, nor any developer who contributed to this project, accept any kind of liability for your use of this library.

This package is not endorsed or affiliated with SensCritique, SensCritique.com, or SENSCRITIQUE SARL

Running project

Clone the repo: git clone git@github.com:miramo/senscritique-api.git

Requirements

Install dependencies

To install dependencies enter project folder and run following command:

yarn

Install & Run TypeScript Compiler

npm install typescript -g
npm install typings -g
typings install
tsc

Run server

To run server execute:

yarn start

API Documentation

See wiki SensCritique API

Testing the API

You can test the API using Postman

Meta

SensCritique API was created by and is maintained by Maxime MIRAMOND.

Distributed under the GPL-3.0+ license. See LICENSE for more information.