2023-11-01 18:01:37 +01:00
# NYX Dashboard
2023-03-03 17:48:43 +01:00
2023-11-01 18:01:37 +01:00
This project is dashboard for its parent project, [NYX ](https://github.com/night0721/cath.exe )
2023-11-02 00:43:26 +01:00
2023-11-02 00:44:21 +01:00
## Features
2023-03-03 17:48:43 +01:00
2023-11-01 18:01:37 +01:00
- Login
- Control Panel
2023-03-03 17:48:43 +01:00
## Run Locally
```bash
2023-11-02 00:43:26 +01:00
git clone https://github.com/night0721/nyx-dashboard.git # clone repository
cd nyx-dashboard # go to project directory
npm install # install dependencies
2023-03-03 17:48:43 +01:00
```
2023-11-02 00:43:26 +01:00
Then edit environment variables at .env.example, also change filename to .env
2023-03-03 17:48:43 +01:00
2023-11-02 00:43:26 +01:00
Last, start the server
2023-03-03 17:48:43 +01:00
```bash
npm run dev
```
## License
2023-11-02 00:43:26 +01:00
This project licensed under the GNU Public License v3.0. See [LICENSE ](https://github.com/night0721/nyx-dashboard ) for more information.
2023-03-03 17:48:43 +01:00
## Authors
2023-11-01 18:01:37 +01:00
- [@chunchunmaru ](https://www.github.com/https://github.com/chunchunmaru )
2023-03-03 17:48:43 +01:00
2023-11-01 18:01:37 +01:00
## 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!
