comty/README.md
2022-03-14 23:13:26 +01:00

45 lines
2.2 KiB
Markdown
Executable File

# Comty - An prototype of an social network
![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)[![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/)
[![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)
[![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 in a social way.
## Getting Started
>Its needed to have installed NodeJS ( v13^ ), Git, and a dependency manager (npm, yarn...)
- Getting the repository
```shell
git clone https://github.com/ragestudio/comty && cd comty
yarn
```
- Starting web development server
```shell
cd packages/app
yarn start
```
- Starting api development server
```shell
cd packages/server
yarn start
```
## Status
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!***
## Tech
![tech](https://dl.ragestudio.net/persistent/CbEWXaE3cB35Rm2TFhY4Hnezr2P7qbtGDG86MPWUa6.png)