night0721/nyx-dashboard
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix typos in readme and add env

Browse source
This commit is contained in:
night0721 2023-11-01 23:43:26 +00:00
parent 09cd680945
commit 32992710a2
2 changed files with 12 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
.env.example Normal file
View file

@ -0,0 +1,3 @@
DISCORD_ID=
DISCORD_SECRET=
DATABASE_URL=

37
README.md
View file

@ -1,42 +1,22 @@
# NYX Dashboard # NYX Dashboard
This project is dashboard for its parent project, [NYX](https://github.com/night0721/cath.exe) This project is dashboard for its parent project, [NYX](https://github.com/night0721/cath.exe)
# Featuers
# Features
- Login - Login
- Control Panel - Control Panel
## Run Locally ## Run Locally
Clone the project
```bash ```bash
git clone https://github.com/night0721/nyx-dashboard.git git clone https://github.com/night0721/nyx-dashboard.git # clone repository
cd nyx-dashboard # go to project directory
npm install # install dependencies
``` ```
Then edit environment variables at .env.example, also change filename to .env
Go to the project directory Last, start the server
```bash
cd nyx-dashboard
```
Install dependencies
```bash
npm install
```
Configure environment variables
.env example
```
DISCORD_ID=
DISCORD_SECRET=
DATABASE_URL=
```
Start the server
```bash ```bash
npm run dev npm run dev
@ -44,7 +24,8 @@ Start the server
## License ## License
This project licensed under the GNU Public LICENSE v3.0. See [LICENSE](https://github.com/night0721/nyx-dashboard) for more information. This project licensed under the GNU Public License v3.0. See [LICENSE](https://github.com/night0721/nyx-dashboard) for more information.
## Authors ## Authors
- [@chunchunmaru](https://www.github.com/https://github.com/chunchunmaru) - [@chunchunmaru](https://www.github.com/https://github.com/chunchunmaru)