nyx-dashboard/README.md

# NYX Dashboard

This project is dashboard for its parent project, [NYX](https://github.com/night0721/cath.exe)

# Features

- Login
- Control Panel

## Run Locally

```bash
  git clone https://github.com/night0721/nyx-dashboard.git # clone repository
  cd nyx-dashboard # go to project directory
  npm install # install dependencies
```
Then edit environment variables at .env.example, also change filename to .env

Last, start the server

```bash
  npm run dev
```

## License

This project licensed under the GNU Public License v3.0. See [LICENSE](https://github.com/night0721/nyx-dashboard) for more information.

## Authors

- [@chunchunmaru](https://www.github.com/https://github.com/chunchunmaru)

## Bugs And Feature Requests

If there is a bug you would wish to report, open a new **issue** and label it as **bug**; these will be high priority changes! If there is a feature you would like to see implemented, open a new **issue** and mark it as an **enhancement**; we'll make sure to get to these!