nyx-dashboard/README.md

55 lines
1.1 KiB
Markdown
Raw Normal View History

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)
# Featuers
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
Clone the project
```bash
2023-11-01 18:01:37 +01:00
git clone https://github.com/night0721/nyx-dashboard.git
2023-03-03 17:48:43 +01:00
```
Go to the project directory
```bash
2023-11-01 18:01:37 +01:00
cd nyx-dashboard
2023-03-03 17:48:43 +01:00
```
Install dependencies
```bash
2023-11-01 18:01:37 +01:00
npm install
2023-03-03 17:48:43 +01:00
```
Configure environment variables
.env example
```
DISCORD_ID=
DISCORD_SECRET=
DATABASE_URL=
```
Start the server
```bash
npm run dev
```
## License
2023-11-01 18:01:37 +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!