marcus-sa / vulture

[WIP] Headless Habbo CMS supporting all major emulators

Home Page:https://habbovulture.docs.apiary.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Vulture

Description

Headless Habbo CMS supporting all major emulators

Installation

Ensure you have yarn installed, otherwise install it npm install -g yarn
This API uses docker, so you must have docker-compose installed

Next step is to install all the required dependencies so that you can setup the API

$ yarn

Setup

Simply run the following command and answer the prompts to setup everything needed

$ yarn setup

Running the app

# docker development
$ yarn dc:dev

# will output docker-machine ip
$ yarn host

Test

# unit tests
$ yarn test

# e2e tests
$ yarn test:e2e

# test coverage
$ yarn test:cov

About

[WIP] Headless Habbo CMS supporting all major emulators

https://habbovulture.docs.apiary.io

License:MIT License


Languages

Language:TypeScript 90.6%Language:API Blueprint 8.0%Language:Dockerfile 1.4%