update readme

This commit is contained in:
srgooglo 2022-03-14 23:13:26 +01:00
parent b61eb77c6f
commit d631a7c255

View File

@ -4,37 +4,41 @@
[![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) [![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)
[![Code Alerts](https://img.shields.io/lgtm/alerts/g/srgooglo/comty.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/srgooglo/comty/alerts/) [![Code Alerts](https://img.shields.io/lgtm/alerts/g/srgooglo/comty.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/srgooglo/comty/alerts/)
[![Grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/srgooglo/comty.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/srgooglo/comty/context:javascript) [![Grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/srgooglo/comty.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/srgooglo/comty/context:javascript)
[![Trello](https://img.shields.io/badge/Trello-Join%20dashboard-blue)](https://trello.com/invite/b/UbwvlG1I/2bc02725b9b210d2e9e9a82c5040b895/comty-development)
[![Discord](https://img.shields.io/badge/dynamic/json?color=blue&label=Discord&query=name&url=https%3A%2F%2Fdiscord.com%2Fapi%2Fguilds%2F769176303978938389%2Fwidget.json)](https://discord.gg/NmnJexe) [![Discord](https://img.shields.io/badge/dynamic/json?color=blue&label=Discord&query=name&url=https%3A%2F%2Fdiscord.com%2Fapi%2Fguilds%2F769176303978938389%2Fwidget.json)](https://discord.gg/NmnJexe)
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 communication with other people. 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 communication with other people in a social way.
## Getting Started ## Getting Started
>Its needed to have installed NodeJS ( v12^ ), Git, and a dependency manager (npm, yarn...) >Its needed to have installed NodeJS ( v13^ ), Git, and a dependency manager (npm, yarn...)
- Getting the repository - Getting the repository
```shell ```shell
git clone https://github.com/srgooglo/comty && cd comty git clone https://github.com/ragestudio/comty && cd comty
npm install yarn
``` ```
- Starting development server - Starting web development server
```shell ```shell
npm start cd packages/app
yarn start
```
- Starting api development server
```shell
cd packages/server
yarn start
``` ```
## Status
This project is in a **very early** design phase, there are still many phases to go through, now **we are looking** for a team to start developing all these factors.
Until we establish this phase, much of the project looks v**ery inconsistent and confusing**.
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**.
As many changes are coming, it is normal for him to change his appearance radically.
Anyway, anyone interested, we are **looking for you**. As at the moment it is very difficult to explain how this works and how this project will be managed, **feel free to contact us.** ## Status
***Very soon*** new updates adding much more information about this project. This project is in a **early** design phase, there are still many phases to go through.
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**.
Now **we are looking** for a team too.
Anyway, anyone interested, we are **looking for you**.
***Soon*** new updates adding much more information about this project.
***Any contribution is very grateful, we need you more than ever!*** ***Any contribution is very grateful, we need you more than ever!***
## Made with
> We use these technologies and many more to make it work
## Tech
![tech](https://dl.ragestudio.net/persistent/CbEWXaE3cB35Rm2TFhY4Hnezr2P7qbtGDG86MPWUa6.png) ![tech](https://dl.ragestudio.net/persistent/CbEWXaE3cB35Rm2TFhY4Hnezr2P7qbtGDG86MPWUa6.png)
*Using the best technologies makes all this a reality and take advantage of the maximum performance*