mirror of
https://github.com/ragestudio/comty.git
synced 2025-06-09 02:24:16 +00:00
Update README
This commit is contained in:
parent
e61d2b79f8
commit
0b84996137
58
README.md
58
README.md
@ -15,16 +15,12 @@ The platform to hold all your creative.
|
|||||||
|
|
||||||
> 👋 We have a official beta instance, you can access it from [https://comty.app](https://comty.app)
|
> 👋 We have a official beta instance, you can access it from [https://comty.app](https://comty.app)
|
||||||
|
|
||||||
## Special Sponsors
|
## 🌟 Some of the features
|
||||||
[](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.
|
📝 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 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™" URL's, including HLS, RTMP, RTSP without vendor lock-in.
|
||||||
|
|
||||||
|
> Now supports restreams! Easily push your streams to whatever you want.
|
||||||
|
|
||||||
🎶 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.
|
🎶 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.
|
||||||
|
|
||||||
@ -33,52 +29,36 @@ The platform to hold all your creative.
|
|||||||
## 🌐 Available platforms
|
## 🌐 Available platforms
|
||||||
We have official public services that you can find on these platforms!
|
We have official public services that you can find on these platforms!
|
||||||
|
|
||||||
🌐 Web | [https://comty.app](https://comty.app)
|
🌐 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)
|
|
||||||
|
|
||||||
|
📱 (Outdated) 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
|
## 🚀 Development
|
||||||
### Prerequisites
|
Check the [getting-started.md](./docs/development/getting-started.md) document to get started with the development.
|
||||||
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).
|
## 🤝 Contributions
|
||||||
|
Contributions to Comty are welcome. If you want to contribute, please follow the instructions mentioned in the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
|
||||||
|
|
||||||
- (Recomended) Use [npm](https://docs.npmjs.com/cli/v11/configuring-npm/install) package manager.
|
## 💅 Code Style
|
||||||
|
Please read the related document [CODE_STYLE.md](./CODE_STYLE.md) for more details.
|
||||||
|
|
||||||
- (Optional) Install [Docker](https://docs.docker.com/get-docker/), used for building and deployment.
|
## 🧑💻 Code of Conduct
|
||||||
|
We provide a [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) file to help you understand what behavior is expected and unacceptable in the project.
|
||||||
|
|
||||||
### Setup
|
## 📜 License
|
||||||
- Getting the repository
|
Comty is licensed under the Comty license. See the [LICENSE](./LICENSE) file for more details.
|
||||||
```shell
|
|
||||||
git clone --recurse-submodules https://github.com/ragestudio/comty && cd comty
|
|
||||||
```
|
|
||||||
|
|
||||||
- Installing all dependencies
|
## 🧑🔬 Status
|
||||||
```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 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.
|
> 👥 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.
|
> 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
|
## :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/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/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>
|
<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>
|
||||||
|
|
||||||
|
## Special Sponsors
|
||||||
|
[](https://plenix.net)
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user