https://github.com/jadiego/react-slack-clone
A full stack chat application similar to Slack, with a custom messaging API backend.
https://github.com/jadiego/react-slack-clone
docker go microservices-architecture mongodb rabbitmq react redis redux typescript
Last synced: 6 months ago
JSON representation
A full stack chat application similar to Slack, with a custom messaging API backend.
- Host: GitHub
- URL: https://github.com/jadiego/react-slack-clone
- Owner: jadiego
- Created: 2017-06-14T22:14:59.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-12-04T13:19:21.000Z (over 7 years ago)
- Last Synced: 2024-08-22T23:56:33.601Z (almost 2 years ago)
- Topics: docker, go, microservices-architecture, mongodb, rabbitmq, react, redis, redux, typescript
- Language: Go
- Homepage:
- Size: 3.1 MB
- Stars: 15
- Watchers: 4
- Forks: 7
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# react-slack-clone
react-slack-clone is an instant messaging web application, similar to Slack, that features a microservice architecture and a React-Typescript with Redux web client.
> ⚠️ No live demo since the API server can't be hosted for free at the moment. To see the app in action more, it has to be run [locally](#development).
## Features
- Realtime instant messaging through websockets client-side, and concurrency practices server-side using go channels and mutexes.
- Private/DM channels using react-router private authenticated routes.
- A chatbot powered by Wit.ai that answers to questions about chat logs.
- credential/session encryption with bcrypt and hmac.
- Restful API structured into three microservices.
## Software Architecture
### Frontend
The web client is was bootstrapped with React with Typescript, using [CRA](https://github.com/wmonk/create-react-app-typescript). Redux was also used to manage application state and react-router to handle client-side routing.
### Server side
The API server uses a **microservices architecture** to decouple the multiple components that comprises the whole API server. Any request sent to the API server first has to go through the API gateway.
The **[gateway](https://github.com/jadiego/react-slack-clone/tree/master/servers/gateway)** is responsible for being the gateway for all client requests for user or messaging data, or to other microservices. The only exposed port is 443, meaning all incoming HTTP requests must be over SSL.
**[messaging](https://github.com/jadiego/react-slack-clone/tree/master/servers/messaging)** is responsible for interacting with the channels and message data on mongoDB.
**[chatbot](https://github.com/jadiego/react-slack-clone/tree/master/servers/chatbot)** is responsible for answering simple chatbot queries.
## Tech Stack
- Go
- Node.js
- Express
- React TypeScript
- Redux
- RabbitMQ
- Redis
- MongoDB
- Wit.ai
## Development
See [backend development guide](servers/README.md) for more on how to setup backend servers for development on local machine. A `docker-compose.yml` has been provided in order to run the proper Docker instances with a simple command.
```
docker-compose up
```
The frontend client can be started using the commands below within the client directory.
```
npm install
HTTPS=true npm start
```