# habboapi-housekeeping

> HabboAPI Housekeeping

Latest version **0.0.2** (published 2017-03-31) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install habboapi-housekeeping
pnpm add habboapi-housekeeping
yarn add habboapi-housekeeping
bun add habboapi-housekeeping
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2017-03-31 |
| First published | 2017-03-31 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 20 |
| Known vulnerabilities | 0 (+16 in 4 direct dependencies) |
| Install scripts | no |
| Author | Billsonnn |
| Maintainers | billsonnn |

## Links

- npm: https://www.npmjs.com/package/habboapi-housekeeping
- Repository: https://github.com/billsonnn/habboapi-housekeeping
- Issues: https://github.com/billsonnn/habboapi-housekeeping/issues
- npm.io page: https://npm.io/package/habboapi-housekeeping

## Dependencies (20)

- [glob](https://npm.io/package/glob.md) ^7.1.1
- [knex](https://npm.io/package/knex.md) ^0.12.7
- [mysql](https://npm.io/package/mysql.md) ^2.13.0
- [regex](https://npm.io/package/regex.md) ^0.1.1
- [bcrypt](https://npm.io/package/bcrypt.md) ^1.0.2
- [angular](https://npm.io/package/angular.md) 1.6.3
- [express](https://npm.io/package/express.md) ^4.15.2
- [bluebird](https://npm.io/package/bluebird.md) ^3.5.0
- [passport](https://npm.io/package/passport.md) ^0.3.2
- [bookshelf](https://npm.io/package/bookshelf.md) ^0.10.3
- [ngstorage](https://npm.io/package/ngstorage.md) ^0.3.11
- [body-parser](https://npm.io/package/body-parser.md) ^1.17.1
- [angular-aria](https://npm.io/package/angular-aria.md) 1.6.3
- [passport-local](https://npm.io/package/passport-local.md) ^1.0.0
- [angular-animate](https://npm.io/package/angular-animate.md) 1.6.3
- [express-session](https://npm.io/package/express-session.md) 1.15.2
- [angular-material](https://npm.io/package/angular-material.md) 1.1.3
- [angular-messages](https://npm.io/package/angular-messages.md) 1.6.3
- [angular-translate](https://npm.io/package/angular-translate.md) ^2.15.1
- [angular-ui-router](https://npm.io/package/angular-ui-router.md) ^0.4.2

## Recent versions

- 0.0.2 (latest) — 2017-03-31

## README

## HabboAPI Housekeeping
arcturus emulator housekeeping written in node & angular using es6

#### about
HabboAPI Housekeeping is a powerful open source housekeeping system for use with Arcturus Emulator. The system is designed to manage all aspects of your database including users, rooms, bans, catalog, groups, furniture, navigator, permissions, and more. The backend is written in node using express and frontend is angular, both written using es6.

#### requirements
* Nodejs v7.x
* NPM
* MySQL Server

#### installation
* [download](https://github.com/billsonnn/habboapi-housekeeping/archive/master.zip) the latest zip
* create a new folder and extract the zip to it
* Open `config.json` & `src/config/constants.js` and modify the keys to your desired settings.
* open command prompt / terminal in root / sudo mode and navigate to the folder you extracted the zip to
* run `npm install -g babel-cli@6.24.0 gulp@3.9.1` 
* run `npm install`
* import `habboapi-housekeeping.sql` to your mysql database
* run `gulp build`
* finally to start the server, run `npm start`

#### features

#### faqs
* what emulator does HabboAPI Housekeeping support?
  * habboapi housekeeping is made for the arcturus emulator database. although with some modifications to the database models this system could be coded for other databases.

* are the users for housekeeping the same as hotel?
  * habboapi housekeeping stores its users in a seperate table for better security.

* how do I make modifications to angularjs & the templates?
  * all code for the frontend can be found in the `src` folder. it is not recommended to make any changes to any of the modules contained here. instead, create a new module and require it into the main app module in `app.js`. all templates are located in `src/views`
  * if you make any changes to the `src` folder you must rebuild the project for your changes to take effect. to do this just open command prompt / terminal and navigate to the folder where habboapi housekeeping. is located and run `gulp build`. also be sure to restart habboapi housekeeping.

---
_Source: https://npm.io/package/habboapi-housekeeping · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._