From 99970a77de9cda8c705f38ccef76101a6387bb19 Mon Sep 17 00:00:00 2001 From: SrGooglo Date: Fri, 30 Dec 2022 15:10:45 +0000 Subject: [PATCH] update readme --- README.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index f1b83eca..45b961aa 100755 --- a/README.md +++ b/README.md @@ -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) -[![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) +[![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) +[![Discord](https://img.shields.io/discord/769176303978938389?label=Discord)](https://discord.gg/2DTjxvnhXG) -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 ->Its needed to have installed NodeJS ( v13^ ), Git, and a dependency manager (npm, yarn...) +## Local development +### 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 ```shell git clone https://github.com/ragestudio/comty && cd comty +``` + +- Installing all dependencies +```shell yarn ``` -- Starting web development server -```shell -cd packages/app -yarn start -``` -- Starting api development server -```shell -cd packages/server -yarn start -``` +### Starting the development server +- 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 -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**. 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