Dekescordes/spacebar
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

📝 update readme

Browse Source
This commit is contained in:
Flam3rboy 2021-08-13 20:54:58 +02:00
parent ea8c47d64e
commit c36f77074a
1 changed files with 34 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -1,15 +1,35 @@
# Fosscord Server <p align="center">
Consists of: <img width="100" src="https://raw.githubusercontent.com/fosscord/fosscord/master/assets/logo_big_transparent.png" />
* HTTP Rest API </p>
* CDN <h1 align="center">Fosscord Server</h1>
* Gateway
* RTC
## Dev getting started <p>
1. Install deps: `npm i` <a href="https://discord.gg/ZrnGQP6p3d">
2. TODO: Configure <img src="https://img.shields.io/discord/806142446094385153?color=7489d5&logo=discord&logoColor=ffffff" />
3. Start the server: </a>
* To run all at once, run `npm start` in root directory. <img src="https://img.shields.io/static/v1?label=Status&message=Development&color=blue">
* To run api, do `npm start` in `api` folder <a title="Crowdin" target="_blank" href="https://translate.fosscord.com/"><img src="https://badges.crowdin.net/fosscord/localized.svg"></a>
* To run cdn, do `npm start` in `cdn` folder <a href="https://opencollective.com/fosscord">
* To run gateway, do `npm start` in `gateway` folder <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_