nyx-dashboard/README.md

63 lines
1,001 B
Markdown
Raw Normal View History

2023-03-03 17:48:43 +01:00
# Cath.gq
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!
## Run Locally
Clone the project
```bash
git clone https://github.com/night0721/cath.gq.git
```
Go to the project directory
```bash
cd cath.gq
```
Install dependencies
```bash
yarn install
```
Configure environment variables
.env example
```
DISCORD_ID=
DISCORD_SECRET=
DATABASE_URL=
```
Start the server
```bash
npm run dev
```
## License
[MIT](https://choosealicense.com/licenses/mit/)
## Demo
[Live](https://cath.gq)
## Authors
- [@qt-coder](https://www.github.com/qt-coder)