diff --git a/docs/resources.md b/docs/resources.md index 15004f0..529e234 100644 --- a/docs/resources.md +++ b/docs/resources.md @@ -1,51 +1,45 @@ ## Links -- [Docs](https://docs.fosscord.com) -- [Status](https://status.fosscord.com/) -- [GitHub](https://github.com/fosscord/fosscord) -- [OpenCollective](https://opencollective.com/fosscord) -- [Roadmap](https://github.com/fosscord/fosscord-api/issues/140) -- [Discord server](https://discord.gg/ZrnGQP6p3d) (If we are finished we'll host our own support server -- [Tor Hidden Service](http://7jexqzsbqndcsh6y7hybtaf5us5vt7mya7hi4fbi2tid6zazno3h44qd.onion/) +- [Documentation](https://docs.fosscord.com) +- [Roadmap](https://fosscord.notion.site/2c7fe9e73f9842d3bab3a4912dedd091) (Notion to-do board synced with GitHub issues) +- [Status](https://status.fosscord.com/) (Status page of the offical foscord instance) +- [GitHub](https://github.com/fosscord/) (GitHub organization) +- [OpenCollective](https://opencollective.com/fosscord) (Financially support the project to cover server costs and other expenses) +- [Discord server](https://discord.gg/ZrnGQP6p3d) (for support & organization (If we are finished we'll host our own support server)) +- [Tor Hidden Service](http://7jexqzsbqndcsh6y7hybtaf5us5vt7mya7hi4fbi2tid6zazno3h44qd.onion/) (Better privacy for TOR users) ## Project structure Fosscord consists of many repositories, which together make up the client and the server: -### Server-side +### Server - [fosscord-api](https://github.com/fosscord/fosscord-api) is the REST HTTP API server. -- [fosscord-gateway](https://github.com/fosscord/fosscord-gateway) is the WebSocket Gateway server. +- [fosscord-gateway](https://github.com/fosscord/fosscord-gateway) is the WebSocket Gateway server +- [fosscord-voice-gateway](https://github.com/fosscord/fosscord-rtc) is the Fosscord Voice Gateway Server - [fosscord-rtc](https://github.com/fosscord/fosscord-rtc) will be the webrtc server for voice and video sharing. +- [fosscord-webrtc-server](https://github.com/fosscord/fosscord-server) is a _javascript_ fosscord webrtc server for voice and video communication - [fosscord-dashboard](https://github.com/fosscord/fosscord-dashboard) An admin dashboard for the server (analytics, settings, administration, trust & safety) - [fosscord-server-util](https://github.com/fosscord/fosscord-server-util) contains all shared logic like Database Models, Utility functions... - [fosscord-cdn](https://github.com/fosscord/fosscord-cdn) is the content-delivery-content (CDN) that stores user uploaded images. -- [fosscord-docs](https://github.com/fosscord/fosscord-docs) Documentation of Fosscord +- [fosscord-server](https://github.com/fosscord/fosscord-server) is the complete bundled fosscord server -### Client-side + +### Client - [fosscord-ui](https://github.com/fosscord/fosscord-ui) is a user interface framework in the style of discord. - [fosscord-themes](https://github.com/fosscord/fosscord-themes) contains all the official themes for the client. - [fosscord-plugins](https://github.com/fosscord/fosscord-plugins) contains all the official plugins for the client. -- [fosscord-landingpage](https://github.com/fosscord/fosscord-landingpage) represents and explains the project. - [fosscord-client](https://github.com/fosscord/fosscord-client) is the official Fosscord client. +- [fosscord-client](https://github.com/fosscord/fosscord-client-native) is the official (react)-native Fosscord client. +- ~~[react-native-withcss](https://github.com/fosscord/react-native-withcss) CSS support for react native~~ (Discontinued) +- ~~[css-mediaquery](https://github.com/fosscord/css-mediaquery) CSS media query support for react native~~ (Discontinued) -#### Discontinued +#### Others -- [react-native-withcss](https://github.com/fosscord/react-native-withcss) -- [css-mediaquery](https://github.com/fosscord/css-mediaquery) - -## Issues - -### Naming convention - -- The issue name must have the main label as a prefix in brackets: e.g. `[Feature] Test` or `[Bug] Test`. - -- The first letter of the prefix and the title must be uppercase. - -- You are not allowed to use CAPS. - -#### Example Issue: -_this issue follows the above mentioned conventions_ - - +- [fosscord-docs](https://github.com/fosscord/fosscord-docs) Documentation of Fosscord +- [fosscord-landingpage](https://github.com/fosscord/fosscord-landingpage) represents and explains the project. +- [fosscord.js](https://github.com/fosscord/fosscord.js) A powerful JavaScript library for interacting with the Fosscord API +- [fosscord.js-builders](https://github.com/fosscord/fosscord.js-builders) A collection of builders that you can use when creating your bot. +- [fosscord.py](https://github.com/fosscord/fosscord.py) An API wrapper for Fosscord written in Python. +- [docker](https://github.com/fosscord/docker) 🐳 Fosscord's Docker images and composing