From c8cf7f05ae0b7aa699a584b5addee28bff4c33e0 Mon Sep 17 00:00:00 2001 From: srgooglo <38926803+srgooglo@users.noreply.github.com> Date: Sun, 25 Oct 2020 20:46:19 +0100 Subject: [PATCH] Update README.md --- README.md | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 386d98ac..6595bad6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,38 @@ + # 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/srgooglo/comty/badge)](https://www.codefactor.io/repository/github/srgooglo/comty) [![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=%235390d9&label=Discord&query=name&url=https%3A%2F%2Fdiscordapp.com%2Fapi%2Fguilds%2F713713091568861197%2Fwidget.json)](https://discord.gg/uMRSKDW) -![CodeQL](https://github.com/srgooglo/comty/workflows/CodeQL/badge.svg?branch=master) +[![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. + + +## Getting Started +>Its needed to have installed NodeJS ( v12^ ), Git, and a dependency manager (npm, yarn...) + +- Getting the repository +```shell +git clone https://github.com/srgooglo/comty && cd comty +npm install +``` + +- Starting development server +```shell +npm 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.** +***Very soon*** new updates adding much more information about this project. + +***Any contribution is very grateful, we need you more than ever!*** +## Made with +> We use these technologies and many more to make it work + +![enter image description here](https://dl.ragestudio.net/persistent/CbEWXaE3cB35Rm2TFhY4Hnezr2P7qbtGDG86MPWUa6.png) +*Using the best technologies makes all this a reality and take advantage of the maximum performance*