mirror of
https://github.com/ragestudio/comty.git
synced 2025-06-09 18:44:16 +00:00
45 lines
2.1 KiB
Markdown
Executable File
45 lines
2.1 KiB
Markdown
Executable File
|
|
# Comty - An prototype of a social network
|
|
|
|
[](https://www.codefactor.io/repository/github/ragestudio/comty)
|
|
[](https://codeclimate.com/github/srgooglo/comty/maintainability)
|
|
[](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 colaboration with other people in a social way.
|
|
|
|
## 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 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 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**.
|
|
|
|
***Any contribution is very grateful, we need you more than ever!***
|
|
|
|
## Tech
|
|
|