Skip to content

Commit

Permalink
docs(readme): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Keritial committed Jun 2, 2022
1 parent d9c4072 commit a23c203
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,28 @@ This is the server of Cridium, written in TypeScript with the [DeepKit](https://
1. Clone the repository, and install the dependencies

```bash
git clone https://github.com/Cridium/cridium-server.git --depth 1
git clone https://github.com/Cridium/cridium-server.git
cd cridium-server
npm install
```

If `npm install` fails, recheck step 2 in prerequisites.
`npm install` will install all the dependencies and rebuild native packages with `node-gyp`, if it fails, recheck step 2 in prerequisites.

2. Copy the example configuration file `.env.example` to `.env` and modify the following

```ini
APP_FRAMEWORK_DEBUG=false
```

to

```ini
APP_FRAMEWORK_DEBUG=true
```

3. Run `npm run dev`

And it's running! Go to your browser and open `http://localhost:8080/_debug`(on WSL, you can see the hostname by executing `hostname -I`), you'll see the DeepKit Debugger.
And it's running! Go to your browser and open `http://localhost:8080/_debug` (on WSL, the port will be automatically forwarded to host, so you can use `localhost` as well), you'll see the DeepKit Debugger.

## License

Expand Down

0 comments on commit a23c203

Please sign in to comment.