mirror of
https://github.com/spacebarchat/spacebarchat.git
synced 2024-11-21 18:02:35 +01:00
✨ readme template
This commit is contained in:
Flam3rboy
parent
a243141fac
commit
86e1560562
93
README.md
93
README.md
@ -1,83 +1,24 @@
|
||||
<p align="center">
|
||||
<img width="100" src="https://raw.githubusercontent.com/fosscord/fosscord/master/assets/logo_big_transparent.png" />
|
||||
</p>
|
||||
<h1 align="center">Fosscord</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://docs.fosscord.com/)
|
||||
|
||||
Fosscord is **f**ree **o**pen **s**ource **s**oftware compatible to dis**cord**. It is a selfhostable Chat, Voice and Video platform similar to Slack, Rocket.chat and Discord-compatible.
|
||||
|
||||
* Discord-compatible
|
||||
* Selfhostable
|
||||
* Open Source
|
||||
* Configurable
|
||||
* Secure
|
||||
* Decentralized
|
||||
* Extendable
|
||||
* Themeable
|
||||
|
||||
Logo by [@nwlandas](https://twitter.com/nwlandas).
|
||||
|
||||
|
||||
### Installation
|
||||
|
||||
_it is in development and not yet finished._
|
||||
[Server]() _(pre alpha)_
|
||||
|
||||
### Support
|
||||
|
||||
[https://discord.gg/ZrnGQP6p3d](https://discord.gg/ZrnGQP6p3d)
|
||||
|
||||
If we are finished we'll host our own support server.
|
||||
|
||||
### Feature Additions:
|
||||
* End to end encryption
|
||||
* Whiteboard integration
|
||||
Client _not finished and still in development_
|
||||
|
||||
### Repositories
|
||||
|
||||
| Repo name | Brief description |
|
||||
| :--- | :--- |
|
||||
| [UI](https://github.com/fosscord/fosscord-ui) | Open Source CSS framework in the style of Discord |
|
||||
| [API](https://github.com/fosscord/fosscord-API) | Fosscord HTTP API Server for fosscord-client |
|
||||
| [Gateway](https://github.com/fosscord/fosscord-gateway) | Fosscord WebSocket Gateway Server for fosscord-client |
|
||||
[Docs](https://github.com/fosscord/fosscord-docs) | Documentation for Fosscord |
|
||||
| [WebRTC Server](https://github.com/fosscord/fosscord-rtc) | Fosscord voice and video server |
|
||||
| [Voice Gateway](https://github.com/fosscord/fosscord-voice-gateway) | Fosscord voice gateway |
|
||||
| [Server-Util](https://github.com/fosscord/fosscord-server-util) | Utility functions for the all server repositories |
|
||||
| [Dashboard](https://github.com/fosscord/fosscord-dashboard) | An admin dashboard for fosscord-server \(analytics, settings, administration, trust & safety\) |
|
||||
| [Client](https://github.com/fosscord/fosscord-client) | Fosscord Client compatible with fosscord-server and discord.com |
|
||||
| [CDN](https://github.com/fosscord/fosscord-cdn) | [Content-delivery-network](https://www.cloudflare.com/learning/cdn/what-is-a-cdn/) for the server, used to store images and assets |
|
||||
| [~~React Native CSS~~](https://github.com/fosscord/react-native-withcss) \(archived\) | ~~Library to enable css support for the client especially for themes~~ |
|
||||
| [~~React Native Mediaquery~~](https://github.com/fosscord/css-mediaquery) \(archived\) | ~~Use CSS media queries with react native~~ |
|
||||
|
||||
### Contribute
|
||||
|
||||
This project is only possible by volunteers like you and me, your contribution is very much appreciated 🥺.
|
||||
|
||||
If you want to make this project reality and and you would like to contribute then [read this issue](https://github.com/fosscord/fosscord/issues/10) first.
|
||||
|
||||
### License
|
||||
|
||||
Copyright (C) 2021 Fosscord and Fosscord Contributors
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero General Public License as
|
||||
published by the Free Software Foundation version 3 of the
|
||||
License
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see https://www.gnu.org/licenses/agpl-3.0.de.html
|
||||
| Repo name | Brief description |
|
||||
| :------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [UI](https://github.com/fosscord/fosscord-ui) | Open Source CSS framework in the style of Discord |
|
||||
| [API](https://github.com/fosscord/fosscord-API) | Fosscord HTTP API Server for fosscord-client |
|
||||
| [Gateway](https://github.com/fosscord/fosscord-gateway) | Fosscord WebSocket Gateway Server for fosscord-client |
|
||||
| [Docs](https://github.com/fosscord/fosscord-docs) | Documentation for Fosscord |
|
||||
| [WebRTC Server](https://github.com/fosscord/fosscord-rtc) | Fosscord voice and video server |
|
||||
| [Voice Gateway](https://github.com/fosscord/fosscord-voice-gateway) | Fosscord voice gateway |
|
||||
| [Server-Util](https://github.com/fosscord/fosscord-server-util) | Utility functions for the all server repositories |
|
||||
| [Dashboard](https://github.com/fosscord/fosscord-dashboard) | An admin dashboard for fosscord-server \(analytics, settings, administration, trust & safety\) |
|
||||
| [Client](https://github.com/fosscord/fosscord-client) | Fosscord Client compatible with fosscord-server and discord.com |
|
||||
| [CDN](https://github.com/fosscord/fosscord-cdn) | [Content-delivery-network](https://www.cloudflare.com/learning/cdn/what-is-a-cdn/) for the server, used to store images and assets |
|
||||
| [~~React Native CSS~~](https://github.com/fosscord/react-native-withcss) \(archived\) | ~~Library to enable css support for the client especially for themes~~ |
|
||||
| [~~React Native Mediaquery~~](https://github.com/fosscord/css-mediaquery) \(archived\) | ~~Use CSS media queries with react native~~ |
|
||||
|
||||
137
assets/readme.svg
Normal file
137
assets/readme.svg
Normal file
@ -0,0 +1,137 @@
|
||||
<body>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="1012" height="1000" version="1.1" style="border: 1px solid black">
|
||||
<defs></defs>
|
||||
<style>
|
||||
text {
|
||||
font-size: 16px;
|
||||
dominant-baseline: hanging;
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
.h1 {
|
||||
font-size: 47px;
|
||||
font-weight: 100;
|
||||
}
|
||||
|
||||
.h2 {
|
||||
font-size: 25px;
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
.link {
|
||||
fill: #0366d6;
|
||||
}
|
||||
|
||||
.center {
|
||||
text-anchor: middle;
|
||||
}
|
||||
</style>
|
||||
<g width="1920" height="1080">
|
||||
<image width="100" height="100" y="75" x="50%" transform="translate(-50, -50)" href="./logo/temp.svg"></image>
|
||||
|
||||
<text y="165" x="50%" class="h1 center">Fosscord</text>
|
||||
|
||||
<svg x="220" y="250" class="center">
|
||||
<a href="https://discord.gg/ZrnGQP6p3d">
|
||||
<image href="https://img.shields.io/discord/806142446094385153?color=7489d5&logo=discord&logoColor=ffffff"></image>
|
||||
</a>
|
||||
|
||||
<a href="https://github.com/fosscord/fosscord-api/issues/140">
|
||||
<image x="125" href="https://img.shields.io/static/v1?label=Status&message=Development&color=blue"></image>
|
||||
</a>
|
||||
|
||||
<a href="https://translate.fosscord.com/">
|
||||
<image x="260" href="https://badges.crowdin.net/fosscord/localized.svg"></image>
|
||||
</a>
|
||||
|
||||
<a href="https://opencollective.com/fosscord">
|
||||
<image x="360" href="https://opencollective.com/fosscord/tiers/badge.svg"></image>
|
||||
</a>
|
||||
</svg>
|
||||
|
||||
<text y="300">
|
||||
<a target="_blank" href="https://docs.fosscord.com/">
|
||||
<tspan class="link h2">
|
||||
About
|
||||
</tspan>
|
||||
</a>
|
||||
<tspan x="0" dy="40">Fosscord is a free open source selfhostable chat, voice and video discord-compatible platform.</tspan>
|
||||
<tspan x="30" dy="30">
|
||||
• Discord-compatible
|
||||
</tspan>
|
||||
<tspan x="30" dy="30">
|
||||
• Selfhostable
|
||||
</tspan>
|
||||
<tspan x="30" dy="30">
|
||||
• Open Source
|
||||
</tspan>
|
||||
<tspan x="30" dy="30">
|
||||
• Configurable
|
||||
</tspan>
|
||||
<tspan x="30" dy="30">
|
||||
• Secure
|
||||
</tspan>
|
||||
<tspan x="30" dy="30">
|
||||
• Decentralized
|
||||
</tspan>
|
||||
<tspan x="30" dy="30">
|
||||
• Extendable
|
||||
</tspan>
|
||||
<tspan x="30" dy="30">
|
||||
• Themeable
|
||||
</tspan>
|
||||
<tspan x="30" dy="30">
|
||||
• End-to-end encryption
|
||||
</tspan>
|
||||
|
||||
<tspan x="0" dy="40" class="h2">
|
||||
Support
|
||||
</tspan>
|
||||
|
||||
<a target="_blank" href="https://discord.gg/ZrnGQP6p3d">
|
||||
<tspan x="0" dy="40" class="link">
|
||||
https://discord.gg/ZrnGQP6p3d
|
||||
</tspan>
|
||||
</a>
|
||||
|
||||
<tspan x="0" dy="30" font-style="italic">
|
||||
If we are finished we'll host our own support server.
|
||||
</tspan>
|
||||
|
||||
<tspan x="0" dy="50" class="h2">
|
||||
Contribute
|
||||
</tspan>
|
||||
|
||||
<tspan x="0" dy="40">
|
||||
This project is only possible by volunteers like you and me, your contribution is very much appreciated.
|
||||
</tspan>
|
||||
|
||||
<tspan x="0" dy="30">
|
||||
If you would like to contribute then
|
||||
<a href="https://github.com/fosscord/fosscord/issues/10">
|
||||
read this issue
|
||||
</a>
|
||||
first.
|
||||
</tspan>
|
||||
|
||||
|
||||
<tspan x="0" dy="30">
|
||||
Logo by
|
||||
<a class="link" target="_blank" href="https://twitter.com/nwlandas">@nwlandas</a>
|
||||
</tspan>
|
||||
|
||||
<tspan x="0" dy="50" class="h2">
|
||||
License
|
||||
</tspan>
|
||||
|
||||
<tspan x="0" dy="40">
|
||||
<a target="_blank" href="https://www.gnu.org/licenses/agpl-3.0.de.html">
|
||||
GNU Affero General Public License V3.0
|
||||
</a>
|
||||
</tspan>
|
||||
|
||||
|
||||
</text>
|
||||
</g>
|
||||
</svg>
|
||||
</body>
|
||||
Loading…
Reference in New Issue
Block a user