Added necessary docs for the repo.

This commit is contained in:
SrGooglo 2023-04-28 18:05:16 +00:00
parent e078d933fd
commit 83ba10c44d
4 changed files with 157 additions and 12 deletions

45
CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,45 @@
# Code of Conduct
## Our Promise
Comty is a space for creativity, learning, and collaboration. We are committed to making our community a welcoming and inclusive space for everyone, regardless of their background or identity. We promise to:
- Respect everyone's opinions, backgrounds, and experiences
- Foster a safe environment for all members to participate and contribute
- Encourage constructive criticism and feedback
- Be open-minded and willing to learn from one another
- Not tolerate any form of discrimination, harassment, or hate speech
## Our standards
To uphold our promise, we expect all members of our community to adhere to the following standards:
- Be respectful and considerate towards others
- Refrain from using discriminatory or offensive language or behavior
- Avoid personal attacks or harassment of any kind
- Listen to and consider the opinions of others, even if they differ from your own
- Report any violations of this Code of Conduct to the Comty team
## Consequences of Unacceptable Behavior
We take violations of this Code of Conduct seriously and will take appropriate action, which may include:
- A warning from the Comty team
- Suspension or removal from the community
- Reporting to relevant authorities, if necessary
- Contact Information
- If you experience or witness any violations of this Code of Conduct, please contact the Comty team at support@ragestudio.net or contact us on Discord.
> We will take all reports seriously and handle them confidentially.
## Acknowledgements
This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

49
CODE_STYLE.md Normal file
View File

@ -0,0 +1,49 @@
# Code Style Guide
## Introduction
This document outlines the code style guidelines for the Comty project. The goal of these guidelines is to create readable, consistent, and maintainable code across the entire codebase.
## General Principles
- Always prioritize code readability and maintainability over cleverness or brevity.
- Write code that is easy to understand by other developers and your future self.
- Follow established patterns and conventions in the codebase, even if it means deviating from personal preferences.
- Write code that is compatible with the latest stable version of the language being used.
- Refactor code as needed to maintain readability and avoid duplication.
## Language-specific Guidelines
### JavaScript
- Use ES6 syntax and features whenever possible.
- Use semicolons to terminate statements.
- Use double quotes for strings, but single quotes for JSX.
- Use const and let instead of var.
- Always use strict equality (=== and !==) for comparisons.
- Avoid using eval() and with().
- Use camelCase for variable and function names.
- Use PascalCase for class and component names.
- Use four spaces for indentation.
- Use a CSS preprocessor like LESS to organize styles. (We recommend use LESS cause it's used in the project, we prefer to no include another dependency)
- Use kebab-case for class and ID names.
- Use four spaces for indentation.
- Use a consistent naming convention for classes and IDs, and avoid using inline styles.
- Use the :hover, :focus, and :active pseudo-classes as needed.
- Use descriptive class and ID names that clearly indicate their purpose.
## Conclusion
By following these code style guidelines, we can create code that is easy to read, understand, and maintain. These guidelines are not exhaustive, and there may be cases where they don't apply or conflict with other guidelines. In such cases, use your best judgement and work with the team to come to a consensus.

35
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,35 @@
# Contributing to Comty
Oh wow! That's gonna be great! thank you for your interest in contributing to Comty! 👍🎉
>The following is a set of guidelines for contributing to Comty. These are just guidelines, not rules, so please use your best judgment and feel free to propose changes to this document in a pull request.
## Code of Conduct
This project and everyone participating in it is governed by the Comty Code of Conduct. By participating, you are expected to uphold this code.
> Please report unacceptable behavior to `support@ragestudio.net` or contact to an administrator on our Discord server.
## How to contribute
- Fork the repository and clone it to your local machine.
- Create a new branch for your changes: ```git checkout -b my-new-feature```
- Make changes and commit them: ```git commit -am 'Add some feature'```
- Push to the branch: ```git push origin my-new-feature```
- Submit a pull request.
- Pull Request Guidelines
- Before you submit a pull request, please make sure your changes meet the following guidelines:
- Your changes **should be** thoroughly tested and include passing test cases. (🙏 We gonna to thank you if you write tests for your code)
- Your code must follow the Comty Code Style.
- Your can document your code to make it easier to understand and review for other developers.
- Your changes must not introduce any critical errors in the build.
- Your changes must be approved by at least one of the maintainers.
## Reporting Bugs
If you find a bug, please open an issue on the GitHub repository. Please include a clear description of the bug, steps to reproduce it, and any relevant error messages.
## Feature Requests
If you have an idea for a new feature, please open an issue on the GitHub repository. Please include a clear description of the feature and why it would be useful.

View File

@ -1,13 +1,29 @@
<img
src="https://storage.ragestudio.net/rstudio/branding/comty/comty_banner_transparent.svg"
width="100%"
alt="Comty logo"
/>
# Comty - An prototype of a social network # Comty - A prototype of a social network
![CodeQL](https://github.com/srgooglo/comty/workflows/CodeQL/badge.svg?branch=master) ![CodeQL](https://github.com/srgooglo/comty/workflows/CodeQL/badge.svg?branch=master)
[![CodeFactor](https://www.codefactor.io/repository/github/ragestudio/comty/badge)](https://www.codefactor.io/repository/github/ragestudio/comty) [![CodeFactor](https://www.codefactor.io/repository/github/ragestudio/comty/badge)](https://www.codefactor.io/repository/github/ragestudio/comty)
[![Maintainability](https://api.codeclimate.com/v1/badges/f89a278695d0a1301fe5/maintainability)](https://codeclimate.com/github/srgooglo/comty/maintainability) [![Maintainability](https://api.codeclimate.com/v1/badges/f89a278695d0a1301fe5/maintainability)](https://codeclimate.com/github/srgooglo/comty/maintainability)
[![Discord](https://img.shields.io/discord/769176303978938389?label=Discord)](https://discord.gg/2DTjxvnhXG) [![Discord](https://img.shields.io/discord/769176303978938389?label=Discord)](https://discord.gg/yxQR6EXf2F)
A prototype of a platform inside of application focused on microservices, extensible and modular, in which the application adapts to your needs, where you will find tools and services allowing you to facilitate colaboration with other people in a social way. A prototype of a platform inside of application focused on services and creatives.
## Local development ## 🌟 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.
## 🚀 Development
### Prerequisites ### Prerequisites
For local development you will need to have installed some tools: For local development you will need to have installed some tools:
@ -17,6 +33,7 @@ For local development you will need to have installed some tools:
- Install [Docker](https://docs.docker.com/get-docker/), used for building and deployment - Install [Docker](https://docs.docker.com/get-docker/), used for building and deployment
### Setup
- Getting the repository - Getting the repository
```shell ```shell
git clone https://github.com/ragestudio/comty && cd comty git clone https://github.com/ragestudio/comty && cd comty
@ -31,14 +48,13 @@ yarn
- You can use the command `yarn dev` to start all development servers with the `nodemon` package, which will restart the server when a file is changed. - You can use the command `yarn dev` to start all development servers with the `nodemon` package, which will restart the server when a file is changed.
## Status ## Status
This project is in a alpha design phase, there are still many phases to go through. 😎 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.
At the moment the ***development is slow but without pause***, because being a very complicated and important phase, we are **prioritizing quality** so that the project base can be 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.
Now **we are looking** for a team too. ## Contributions 🤝
Anyway, anyone interested, we are **looking for you**. Contributions to Comty are welcome. If you want to contribute, please follow the instructions mentioned in the CONTRIBUTING.md file.
***Any contribution is very grateful, we need you more than ever!*** ## License 📜
Comty is licensed under the LGPL-2.1 license. See the LICENSE file for more details.
## Tech
![tech](https://dl.ragestudio.net/persistent/CbEWXaE3cB35Rm2TFhY4Hnezr2P7qbtGDG86MPWUa6.png)