diff options
| author | Flam3rboy <34555296+Flam3rboy@users.noreply.github.com> | 2021-08-13 20:54:58 +0200 |
|---|---|---|
| committer | Flam3rboy <34555296+Flam3rboy@users.noreply.github.com> | 2021-08-13 20:54:58 +0200 |
| commit | a872cadaf27944027d14b4ccfd392dd9290c296d (patch) | |
| tree | 17151f2af761c2f09558535d653d8564bc5eec1e /README.md | |
| parent | :bug: fix bundle listen (diff) | |
| download | server-a872cadaf27944027d14b4ccfd392dd9290c296d.tar.xz | |
:pencil: update readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 50 |
1 files changed, 35 insertions, 15 deletions
diff --git a/README.md b/README.md index c679e685..1c9e6cec 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,35 @@ -# 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 +<p align="center"> + <img width="100" src="https://raw.githubusercontent.com/fosscord/fosscord/master/assets/logo_big_transparent.png" /> +</p> +<h1 align="center">Fosscord Server</h1> + +<p> + <a href="https://discord.gg/ZrnGQP6p3d"> + <img src="https://img.shields.io/discord/806142446094385153?color=7489d5&logo=discord&logoColor=ffffff" /> + </a> + <img src="https://img.shields.io/static/v1?label=Status&message=Development&color=blue"> + <a title="Crowdin" target="_blank" href="https://translate.fosscord.com/"><img src="https://badges.crowdin.net/fosscord/localized.svg"></a> + <a href="https://opencollective.com/fosscord"> + <img src="https://opencollective.com/fosscord/tiers/badge.svg"> + </a> +</p> + +## [About](https://fosscord.com) + +This repository contains: + +- [Fosscord HTTP API Server](https://github.com/fosscord/fosscord-server/tree/master/api) +- [WebSocket Gateway Server](https://github.com/fosscord/fosscord-server/tree/master/gateway) +- [HTTP CDN Server](https://github.com/fosscord/fosscord-server/tree/master/cdn) +- [Utility and Database Models](https://github.com/fosscord/fosscord-server/tree/master/util) +- [RTC Server](https://github.com/fosscord/fosscord-server/tree/master/rtc) +- [WebRTC Server](https://github.com/fosscord/fosscord-server/tree/master/webrtc) +- [Admin Dashboard](https://github.com/fosscord/fosscord-server/tree/master/dashboard) + +## [Ressources](https://docs.fosscord.com/resources/) + +- [Contributing](https://docs.fosscord.com/contributing/) + +## [Download](https://github.com/fosscord/fosscord-server/releases) + +- _is not done yet_ |