mirror of
https://github.com/ragestudio/comty.git
synced 2025-06-09 18:44:16 +00:00
85 lines
4.1 KiB
Markdown
Executable File
85 lines
4.1 KiB
Markdown
Executable File
<p align="center">
|
||
<img
|
||
alt="Comty logo"
|
||
src="https://storage.ragestudio.net/rstudio/branding/comty/iso/basic_alt.svg"
|
||
height="150px"
|
||
/>
|
||
</p>
|
||
|
||
# Comty™
|
||
[](https://www.codefactor.io/repository/github/ragestudio/comty)
|
||
[](https://codeclimate.com/github/srgooglo/comty/maintainability)
|
||
[](https://discord.gg/yxQR6EXf2F)
|
||
|
||
The platform to hold all your creative.
|
||
|
||
> 👋 We have a official beta instance, you can access it from [https://comty.app](https://comty.app)
|
||
|
||
## Special Sponsors
|
||
[](https://plenix.net)
|
||
|
||
|
||
## 🌟 Some of features
|
||
🚀 Real-time updates are provided to users about various activities such as new followers, likes, posts, comments, and more, thanks to a bid event engine that uses websockets.
|
||
|
||
📝 A microblogging system similar to Twitter allows users to post short messages with attachments and more.
|
||
|
||
🎥 Comty TV is a live video streaming feature that allows users to stream their videos, events, or anything else in real-time to other users. It provides playback anywhere, including HLS, RTMP, FLV, and WebRTC, without vendor lock-in.
|
||
|
||
🎶 Comty Music lets users publish their music masterpieces, share their playlists with other users, and synchronize their music with other platforms. A powerful music player is also included in the application.
|
||
|
||
🧩 Modular and Extensible architecture allows developers to create and publish extensions for the platform using the powerful API provided by Comty.
|
||
|
||
## 🌐 Available platforms
|
||
We have official public services that you can find on these platforms!
|
||
|
||
🌐 Web | [https://comty.app](https://comty.app)
|
||
|
||
📱 Android APK (unsigned) (bundle auto update) | [https://github.com/ragestudio/comty/releases/download/0.50.4/app-release.apk](https://github.com/ragestudio/comty/releases/download/0.50.4/app-release.apk)
|
||
|
||
|
||
## 🚀 Development
|
||
### Prerequisites
|
||
For local development you will need to have installed some tools:
|
||
|
||
- Install Node.js (v18 or higher) [manualy](https://nodejs.org/en/download/) or use [nvm](https://github.com/nvm-sh/nvm) tool (or similar tools).
|
||
|
||
- (Recomended) Use [npm](https://docs.npmjs.com/cli/v11/configuring-npm/install) package manager.
|
||
|
||
- (Optional) Install [Docker](https://docs.docker.com/get-docker/), used for building and deployment.
|
||
|
||
### Setup
|
||
- Getting the repository
|
||
```shell
|
||
git clone --recurse-submodules https://github.com/ragestudio/comty && cd comty
|
||
```
|
||
|
||
- Installing all dependencies
|
||
```shell
|
||
npm install
|
||
```
|
||
|
||
### Starting the development server
|
||
- You can use the command `npm run dev` to start all development servers.
|
||
```shell
|
||
npm run dev
|
||
```
|
||
|
||
## 🧑💻 Status
|
||
The project is in alpha design phase, and the development is slow but continuous, prioritizing quality to ensure the project base is preserved for a long time.
|
||
|
||
> 👥 The Comty team is looking for new members, and any contribution to the project is very welcome.
|
||
|
||
> If you are interested in more depth in the project, you can join our [Discord server](https://discord.gg/yxQR6EXf2F) and talk to us.
|
||
|
||
## 🤝 Contributions
|
||
Contributions to Comty are welcome. If you want to contribute, please follow the instructions mentioned in the CONTRIBUTING.md file.
|
||
|
||
## 📜 License
|
||
Comty is licensed under the Comty license. See the LICENSE file for more details.
|
||
|
||
## :heart: Thanks to our supporters
|
||
<kbd><img src="https://avatars.githubusercontent.com/u/94137617?v=4" href="https://github.com/SoyRage" height="64" width="64" border="1px" align="center"></kbd>
|
||
<kbd><img src="https://avatars.githubusercontent.com/u/84641340?v=4" href="https://github.com/FoxasFoxVulpes" height="64" width="64" border="1px" align="center"></kbd>
|
||
<kbd><img src="https://avatars.githubusercontent.com/u/179495972?v=4" href="https://github.com/asiersinmasdev" height="64" width="64" border="1px" align="center"></kbd>
|