# Metahkg Web

This is the metahkg web app. See the [metahkg repository](https://gitlab.com/metahkg/metahkg).

stable (master branch): [metahkg.org](https://metahkg.org)

dev (dev branch): [dev.metahkg.org](https://dev.metahkg.org)

[![React](https://badges.aleen42.com/src/react.svg)](http://reactjs.org/)
[![Typescript](https://badges.aleen42.com/src/typescript.svg)](https://www.typescriptlang.org/)

[![Gitlab](https://badges.aleen42.com/src/gitlab.svg)](https://gitlab.com/metahkg/metahkg-web)
[![Github](https://badges.aleen42.com/src/github.svg)](https://github.com/metahkg/metahkg-web)
[![License](https://img.shields.io/gitlab/license/metahkg/metahkg-web)](https://gitlab.com/metahkg/metahkg-web/-/tree/master/LICENSE.md)

[![DeepSource](https://deepsource.io/gh/metahkg/metahkg-web.svg/?label=active+issues&show_trend=true&token=oM1NNBO8D9mefjjcuiCmPQoS)](https://deepsource.io/gh/metahkg/metahkg-web/?ref=repository-badge)
[![DeepSource](https://deepsource.io/gh/metahkg/metahkg-web.svg/?label=resolved+issues&show_trend=true&token=oM1NNBO8D9mefjjcuiCmPQoS)](https://deepsource.io/gh/metahkg/metahkg-web/?ref=repository-badge)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/0c0ee09f0cca4d6fa17d3b4f4465faf8)](https://www.codacy.com/gl/metahkg/metahkg-web/dashboard?utm_source=gitlab.com&utm_medium=referral&utm_content=metahkg/metahkg-web&utm_campaign=Badge_Grade)

[![Telegram](https://patrolavia.github.io/telegram-badge/chat.svg)](https://t.me/+WbB7PyRovUY1ZDFl)
[![Discord](https://img.shields.io/discord/992390401740775555)](https://discord.gg/yrf2v8KGdc)

## Deploying

### Docker

It is recommended to use docker for deployment (also supports hot reload).

[Docs](https://docs.metahkg.org/docs/category/deploy-metahkg)

### Manually

> **_WARNING:_** This is NOT RECOMMENDED and might be OUTDATED!

For manual deployment, see DEPLOY.md.

## Use as a module

Since v2.4.0, metahkg-web can be used as a module.

### Install

```bash
yarn add metahkg-web
```

### Usage

```tsx
import React from "react";
import MetahkgWebApp from "metahkg-web";

export default function App() {
    return <MetahkgWebApp reCaptchaSiteKey={"<your-recaptcha-site-key>"} />;
}
```

### Build from source

```bash
yarn build:module
```

The artifact would be in ./dist

## License

[AGPL-3.0-or-later](./LICENSE.md).

### Logo

Logo (public/images/logo.svg) originally by "white card", CC-BY-4.0.
Modified versions by wcyat, CC0.
See [public/images/LICENSE](./public/images/LICENSE) for details.