metahkg-server

Metahkg server

This is the Metahkg backend api. See the metahkg repository.

stable (master): metahkg.org

dev build (dev): dev.metahkg.org

Deploying

Docker

Docs

Manually

WARNING: This is NOT RECOMMENDED and might be OUTDATED!

For manual deployment, see DEPLOY.md.

OpenApi specification

See openapi spec.

Api docs

See api in metahkg docs.

Use as module

Install

yarn add metahkg-server

Usage

import MetahkgServer from "metahkg-server";

(async () => {
    await client.connect();
    await setup();

    const app = await MetahkgServer();

    /**
     * The port can be modified in .env
     */
    await app.listen(3000, "0.0.0.0", (err: Error) => {
        if (err) console.log(err);
        console.log(`listening at port ${process.env.port || 3200}`);
    });
})();

quick start for dev

ensure you have .env in root and have docker installed.

docker-compose -f docker-compose-dev.yml up --build