nyx-dashboard/README.md

63 lines
939 B
Markdown
Raw Normal View History

2021-06-20 13:39:00 +02:00
2021-06-21 06:27:03 +02:00
# Cath.gq
2021-06-20 13:39:00 +02:00
2021-06-21 06:27:03 +02:00
Cath.gq is the dashboard for its parent project, [Cath.exe](https://github.com/night0721/cath.exe)
## 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!
2021-06-21 06:27:03 +02:00
## Run Locally
Clone the project
2021-06-20 13:39:00 +02:00
```bash
2021-06-21 06:27:03 +02:00
git clone https://github.com/night0721/cath.gq.git
2021-06-20 13:39:00 +02:00
```
2021-06-21 06:27:03 +02:00
Go to the project directory
2021-06-20 13:39:00 +02:00
2021-06-21 06:27:03 +02:00
```bash
cd cath.gq
```
2021-06-20 13:39:00 +02:00
2021-06-21 06:27:03 +02:00
Install dependencies
2021-06-20 13:39:00 +02:00
2021-06-21 06:27:03 +02:00
```bash
yarn install
```
Configure environment variables
.env example
```
DISCORD_ID=
DISCORD_SECRET=
DATABASE_URL=
```
2021-06-21 06:27:03 +02:00
Start the server
```bash
npm run dev
```
2021-06-20 13:39:00 +02:00
2021-06-21 06:27:03 +02:00
## License
2021-06-20 13:39:00 +02:00
2021-06-21 06:27:03 +02:00
[MIT](https://choosealicense.com/licenses/mit/)
2021-06-20 13:39:00 +02:00
2021-06-21 06:27:03 +02:00
## Demo
2021-06-20 13:39:00 +02:00
2021-06-21 06:27:03 +02:00
[Live](https://cath.gq)
2021-06-20 13:39:00 +02:00
2021-06-21 06:27:03 +02:00
## Authors
2021-06-20 13:39:00 +02:00
2021-06-21 06:27:03 +02:00
- [@qt-coder](https://www.github.com/qt-coder)
2021-06-20 13:39:00 +02:00