-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(readme): add basic introduction
- Loading branch information
Showing
1 changed file
with
31 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,31 @@ | ||
# Cridium/Server | ||
# Cridium Server | ||
This is the server of Cridium, written in TypeScript with the [DeepKit](https://deepkit.io) framework. | ||
|
||
## How to debug | ||
### Prerequisites | ||
1. Git and Nodejs 16+ installed. | ||
2. `python3` and `build-essential` installed if you're on Linux, or follow [`node-gyp`'s guideline](https://github.com/nodejs/node-gyp#on-windows) if you're on Windows. | ||
|
||
### Steps | ||
1. Clone the repository, and install the dependencies | ||
|
||
```bash | ||
git clone https://github.com/Cridium/cridium-server.git --depth 1 | ||
cd cridium-server | ||
npm install | ||
``` | ||
|
||
If `npm install` fails, recheck step 2 in prerequisites. | ||
|
||
2. Copy the example configuration file `.env.example` to `.env` and modify the following | ||
|
||
``` | ||
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. | ||
|
||
## License | ||
Apache License 2.0 |