summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
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