a modern restapi server written in typescript for interacting with Arcturus Emulator
Description
HabboAPI is a collection of packages that once put together, create secure restapi endpoints designed to interact with Arctrus Emulator.
Under the hood, HabboAPI is using the NestJS framework to easily create manageable, modular code. The system is designed around an Angular like dependency injection system. This allows for great code seperation, while easily injecting data from a seperate module.
HabboAPI has 4 main modules designed to be used together
@habboapi/common
@habboapi/emulator
@habboapi/habbo
@habboapi/securityEach module has different dependencies while also relying on eachother.
@habboapi/common
@habboapi/common is our main module, it has no dependencies of other modules, but other modules may depend it.
The following is handled by this module
- BackupService
- Provides the ability to backup specified MySQL tables and save the data to a file.
- ConfigService
- Provides the ability for modules to interact with the global configuration and use its values.
- LogService
- Provides the ability to write to the built in logger which can save outputted data.
- Database Initialization
- Initalizes the TypeORM system and registers all entities across the system.
@habboapi/common
@habboapi/common is our main module, it has no dependencies of other modules, but other modules may depend it.
The following is handled by this module
- BackupService
- Provides the ability to backup specified MySQL tables and save the data to a file.
- ConfigService
- Provides the ability for modules to interact with the global configuration and use its values.
- LogService
- Provides the ability to write to the built in logger which can save outputted data.
- Database Initialization
- Initalizes the TypeORM system and registers all entities across the system.