Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/magnuschase03/discordclone

A full stack chat application
https://github.com/magnuschase03/discordclone

chat docker expressjs mongodb nginx reactjs

Last synced: 22 days ago
JSON representation

A full stack chat application

Awesome Lists containing this project

README

        

![issues-shield]
![forks-shield]
![stars-shield]
![license-shield]

Discord Clone


A little chat app inspired by discord


·
Report Bug
·
Request Feature

Table of Contents



  1. About The Project



  2. Getting Started


  3. Usage

  4. License

## About The Project

My and a friend wanted to prep our javascript skills for an upcoming hackathon, so we decided to put our skills to the test making a discord clone. This app is designed to be a simple chat application where users can create chat servers and talk amongst themselves.

(back to top)

### Built With

* ![react-shield]
* ![node-shield]
* ![redis-shield]
* ![mongo-shield]
* ![nginx-shield]
* ![docker-shield]

(back to top)

## Getting Started

### Prerequisites

To build this project yourself, you are going to need docker and yarn

1) Go to [docker](https://docs.docker.com/engine/install/) and install docker
2) Then go to [docker compose](https://docs.docker.com/compose/install/) and install docker compose
3) Install yarn by `npm install --global yarn`

### Installation

Build the docker images and install frontend dependecies

1) `docker-compose build`
2) `cd frontend && yarn`

## Usage

To run the backend database and API

```
docker-compose up
```

Then start the front end

```
yarn run dev
```

The app then should be running at `localhost:[PORT]`

(back to top)

## License

Distributed under the GPL License. See `LICENSE.txt` for more information.

(back to top)

[issues-shield]: https://img.shields.io/github/issues/MagnusChase03/DiscordClone?style=for-the-badge
[forks-shield]: https://img.shields.io/github/forks/MagnusChase03/DiscordClone?style=for-the-badge
[stars-shield]: https://img.shields.io/github/stars/MagnusChase03/DiscordClone?style=for-the-badge
[license-shield]: https://img.shields.io/github/license/magnuschase03/DiscordClone?style=for-the-badge
[node-shield]: https://img.shields.io/badge/NodeJS-20232A?style=for-the-badge&logo=node.js
[mongo-shield]: https://img.shields.io/badge/MongoDB-20232A?style=for-the-badge&logo=mongodb
[react-shield]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react
[docker-shield]: https://img.shields.io/badge/Docker-20232A?style=for-the-badge&logo=docker
[nginx-shield]: https://img.shields.io/badge/Nginx-20232A?style=for-the-badge&logo=nginx
[redis-shield]: https://img.shields.io/badge/Redis-20232A?style=for-the-badge&logo=redis