update readme

This commit is contained in:
SrGooglo 2022-12-30 15:10:45 +00:00
parent 0b232dbae4
commit 99970a77de

View File

@ -1,43 +1,43 @@
# Comty - An prototype of an social network # Comty - An 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)[![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)
[![Code Alerts](https://img.shields.io/lgtm/alerts/g/srgooglo/comty.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/srgooglo/comty/alerts/) [![Maintainability](https://api.codeclimate.com/v1/badges/f89a278695d0a1301fe5/maintainability)](https://codeclimate.com/github/srgooglo/comty/maintainability)
[![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/discord/769176303978938389?label=Discord)](https://discord.gg/2DTjxvnhXG)
[![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. 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.
## Getting Started ## Local development
>Its needed to have installed NodeJS ( v13^ ), Git, and a dependency manager (npm, yarn...) ### Prerequisites
For local development you will need to have installed some tools:
- Install Node.js (v13 or higher) [manualy](https://nodejs.org/en/download/) or use [nvm](https://github.com/nvm-sh/nvm) tool (Recommended)
- Install [Yarn](https://yarnpkg.com/getting-started/install) package manager (Recommended)
- Install [Docker](https://docs.docker.com/get-docker/), used for building and deployment
- 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
```
- Installing all dependencies
```shell
yarn yarn
``` ```
- Starting web development server ### Starting the development server
```shell - 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.
cd packages/app
yarn start
```
- Starting api development server
```shell
cd packages/server
yarn start
```
## Status ## Status
This project is in a **early** design phase, there are still many phases to go through. This project is in a alpha 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**. 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. Now **we are looking** for a team too.
Anyway, anyone interested, we are **looking for you**. 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!***
## Tech ## Tech