Skip to content

Latest commit

 

History

History
156 lines (124 loc) · 4.94 KB

README.md

File metadata and controls

156 lines (124 loc) · 4.94 KB
Raw

Contributors Forks Stargazers Issues License LinkedIn


Client API

Logo

Chatterer

An open-source family scale chatting application for everyone !

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contact

About The Project

Chatterer is an open-source chatting web application. At first, this project was essentially for development practice purpose but I thought that an simple open-souce chatting application for everyone would be so cool !

So feel free to:

  • Use the app with your friends
  • Contribute to the application
  • Give features ideas

Built With

Chatterer is built with :

  • Docker
  • React
  • Symfony
  • Nginx
  • Swagger

Features

Chatterer is mostly inspired by Slack and Discord. If you want to see the features documentation you can go to the API Gherkin Documentation which is API acceptances tests (Behat)

Logo
Preview

Getting Started

This is a quick start to install the application locally

Prerequisites

You need docker on your machine to get Chatterer working.

  • docker >=20.10.14 is required

Installation

  1. First clone the repository
git clone [email protected]:Zusoy/chatterer.git
  1. Copy .env file
cp -n .env.dist .env
  1. Build the app:
make build
  1. And then start it:
make start
  1. Access links:
URL Link
http://127.0.0.1:8081 API
http://127.0.0.1:8081/doc Swagger
http://127.0.0.1:3000 Client

Contact

Project Link: https://github.com/Zusoy/chatterer