Open Source Chat. Free for All. For Developers. ✨

Community · Contribute · Documentation · FAQ

---

Gitchat is an open sourced chat application that provides messaging and interactive audio room spaces!

Installation

This is an elaborate walkthrough on the installation and configuration of Gitchat on your local machine, for development purposes.

Project Structure

This is the structure of the application. For easier navigation and to prevent an intimmidating looking repository, the folders are named after greek olympian Gods.

Folder	Description
Aries	React App
Chronos	Elixir Server
Flask	Python Stuff
Hades	Nodejs backend
Poseidon	Electron Wrapper
Zeus	Expo CLI App

Requirements

It is worthy to note that you do not require all these tools, except the ones ticked which are necessary for working with all parts of the project currently.

1. Node.js✔️
2. Expo CLI tools ✔️
3. Docker
4. Elixir/Erlang VM
5. MySQL ✔️
6. Postgres SQL
7. GraphQL
8. Python & PIP ✔️
9. Yarn ✔️

Getting Started

Note this is just an all round installation. Each folder, has it's own specific configuration and requirements.

Install Node.js for your machine by clicking here. Remember to check and verify the installation.

STEP 1

$ node -v

Check your npm version as well. Though we'd be using Yarn instead of NPM.

$ npm -v

STEP 2

Install Docker. Not really compulsory, if you do not want to run the application within containers. Install here.

STEP 3

Install Python. From here.

Install virtualenv

$ pip install virtualenv

Install flask

$ pip install flask

Just so you have the basic environment setup.

STEP 3

Not really compulsory to install Elixir, but see the chronos folder for an elaborate installation guide.

STEP 4

Clone this repository. You would need Gitbash on your local machine to execute this. Install Gitbash. Now in your git terminal, or VsCode preferrably, navigate to source control. Click on clone repository Enter this link: https://github.com/grayoj/gitchat.git

OR terminal way:

$ git clone https://github.com/grayoj/gitchat.git

Now cd into the root directory. Have fun or start contributing! More detailed guidelines, for specific tasks coming.

Languages & Stacks 🐱‍🏍

The Web Application

• TypeScript
• JavaScript
• Elixir
• PostgreSQL/MYSQL
• Python
• Node.js

The Desktop Application

• Electron

Mobile Application

• React Native

These are all subject to change depending on any unforseen circumstances.

License 🔑

MIT License.

Contributions 🎯

This is an open source project, feel free to contribute, and generate Pull requests. Open issues to request for corrections and features, including pull requests which would be approved.

Kindly see our contribution guidelines for more information on the project, by clicking here! 🐱‍🏍

Collaborators 👨‍👧‍👧

Some of the people that really want to make this happen and started it:

• @grayoj
• @icaruschan
• @collins2005
• @RoyWealth
• @SilPix
• @Ftgeorge
• @teddyoweh
• @Kamaldeenyusuff
• @Ahmaduabubakarr