From 9a36f9bf4e64db3dc6731e16aa1e8964ddc15035 Mon Sep 17 00:00:00 2001 From: darkhpp Date: Fri, 13 Aug 2021 13:34:00 +0700 Subject: [ProjectManagement] Add root project and dev getting started guides. --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md (limited to 'README.md') 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 -- cgit 1.5.1