arunacore-api

ArunaCore

Summary

0 - TODO List

1 - Introduction

2 - Installation

3 - Wiki

4 - API

5 - Contributing

6 - Authors

7 - License

TODO

• Implement plugins
• Create the wiki
• Improve Todo List

Introduction

ArunaCore is a framework that helps developers to build their own applications.

with it is ease to create and manange a new application created from scratch or to use on top of existing application.

It uses websocket to communicate with your application and it is easy to use.

You can also develop your own plugins to extend the functionality of ArunaCore (SOON:tm:).

Installation

TODO

Wiki

If you have any question, please check our Wiki (WIP), contact us on Github Issues Tab or in the Discord.

API

Using the API is easy!

Installing:

To install, just use npm install arunacore-apior yarn add arunacore-api.

Creating a client:

import { ArunaClient } from 'arunacore-api';

const client = new ArunaClient('localhost', 3000, '<clientName>');

client.connect();

Receiving a message:

The message is received as a JSON object with parsed informations.

client.on('message', (message) => {
  console.log(message);
});

The full documentation:

You can find the full documentation on Wiki.

Contributing

If you want to contribute to ArunaCore, please check our CONTRIBUTING.md file (TODO).

Authors

ArunaCore is developed with 💜 by Lobo Metalurgico and SpaceFox.

License

ArunaCore is licensed under the GPL-3.0 license.