54 lines
1.1 KiB
Markdown
54 lines
1.1 KiB
Markdown
# NYX Dashboard
|
|
|
|
This project is dashboard for its parent project, [NYX](https://github.com/night0721/cath.exe)
|
|
# Featuers
|
|
|
|
- Login
|
|
- Control Panel
|
|
|
|
|
|
## Run Locally
|
|
|
|
Clone the project
|
|
|
|
```bash
|
|
git clone https://github.com/night0721/nyx-dashboard.git
|
|
```
|
|
|
|
Go to the project directory
|
|
|
|
```bash
|
|
cd nyx-dashboard
|
|
```
|
|
|
|
Install dependencies
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
Configure environment variables
|
|
|
|
.env example
|
|
```
|
|
DISCORD_ID=
|
|
DISCORD_SECRET=
|
|
DATABASE_URL=
|
|
```
|
|
|
|
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!
|