summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorFlam3rboy <34555296+Flam3rboy@users.noreply.github.com>2021-08-13 13:08:14 +0200
committerFlam3rboy <34555296+Flam3rboy@users.noreply.github.com>2021-08-13 13:08:14 +0200
commiteebe4d14b29f43c91efc52b51c417718a3e11fbb (patch)
treed7643f3ea698a13d305266a6938b722f7be4fe8d /README.md
parentMerge branch 'master' of https://github.com/fosscord/fosscord-api (diff)
parentMerge branch 'master' into pr/darkhpp/261-2 (diff)
downloadserver-eebe4d14b29f43c91efc52b51c417718a3e11fbb.tar.xz
Merge branch 'pr/darkhpp/261-2'
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644

index 00000000..c679e685 --- /dev/null +++ b/README.md
@@ -0,0 +1,15 @@ +# Fosscord Server +Consists of: + * HTTP Rest API + * CDN + * Gateway + * RTC + +## Dev getting started +1. Install deps: `npm i` +2. TODO: Configure +3. Start the server: + * To run all at once, run `npm start` in root directory. + * To run api, do `npm start` in `api` folder + * To run cdn, do `npm start` in `cdn` folder + * To run gateway, do `npm start` in `gateway` folder