diff options
| author | darkhpp <sevastyandeveloper@gmail.com> | 2021-08-13 13:34:00 +0700 |
|---|---|---|
| committer | darkhpp <sevastyandeveloper@gmail.com> | 2021-08-13 13:34:00 +0700 |
| commit | 2c2d815c53f02082213f05aa3f5e0021cb6c8e55 (patch) | |
| tree | 55a5c0bbdd6e2a819dbd4634b08afadf67241cf6 /README.md | |
| parent | Merge pull request #256 from luth31/master (diff) | |
| download | server-2c2d815c53f02082213f05aa3f5e0021cb6c8e55.tar.xz | |
[ProjectManagement] Add root project and dev getting started guides.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
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 |