diff options
author | vantezzen <properly@protonmail.com> | 2019-08-22 11:12:36 +0200 |
---|---|---|
committer | vantezzen <properly@protonmail.com> | 2019-08-22 11:12:36 +0200 |
commit | b018adf240679ec59a7344e30be39400f1ecd8af (patch) | |
tree | c076635761667dad302716b498088f1047281e46 /README.md | |
download | ferdium-server-b018adf240679ec59a7344e30be39400f1ecd8af.tar.gz ferdium-server-b018adf240679ec59a7344e30be39400f1ecd8af.tar.zst ferdium-server-b018adf240679ec59a7344e30be39400f1ecd8af.zip |
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..75cbd15 --- /dev/null +++ b/README.md | |||
@@ -0,0 +1,17 @@ | |||
1 | # ferdi-server | ||
2 | Unofficial Franz server replacement for use with the Ferdi Client. | ||
3 | |||
4 | ## Setup | ||
5 | 1. Clone this repository | ||
6 | 2. Install the [AdonisJS CLI](https://adonisjs.com/) | ||
7 | 3. Run the database migrations with | ||
8 | ```js | ||
9 | adonis migration:run | ||
10 | ``` | ||
11 | 4. Start the server with | ||
12 | ```js | ||
13 | adonis serve --dev | ||
14 | ``` | ||
15 | |||
16 | ## License | ||
17 | ferdi-server is licensed under the MIT License \ No newline at end of file | ||