Merge branch 'master' of https://github.com/DisTwitchChate/App

CONTRIBUTING.md

@@ -0,0 +1,95 @@
+If you don't have git on your machine, [install it]( https://help.github.com/articles/set-up-git/).
+
+## Fork this repository
+
+Fork this repository by clicking on the fork button on the top of this page.
+This will create a copy of this repository in your account.
+
+## Clone the repository
+
+<img align="right" width="300" src="https://raw.githubusercontent.com/firstcontributions/first-contributions/master/assets/clone.png" alt="clone this repository" />
+
+Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the clone button and then click the *copy to clipboard* icon.
+
+Open a terminal and run the following git command:
+
+```
+git clone "url you just copied"
+```
+where "url you just copied" (without the quote marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.
+
+<img align="right" width="300" src="https://raw.githubusercontent.com/firstcontributions/first-contributions/master/assets/copy-to-clipboard.png" alt="copy URL to clipboard" />
+
+For example:
+```
+git clone https://github.com/this-is-you/App.git
+```
+where `this-is-you` is your GitHub username. Here you're copying the contents of the minimal-portfolio repository on GitHub to your computer.
+
+## Create a branch
+
+Change to the repository directory on your computer (if you are not already there):
+
+```
+cd App
+```
+Now create a branch using the `git checkout` command:
+```
+git checkout -b <add-your-new-branch-name>
+```
+
+For example:
+```
+git checkout -b add-macho-coder
+```
+(The name of the branch does not need to have the word *add* in it, but it's a reasonable thing to include because the purpose of this branch is to add your name to a list.)
+
+## Make necessary changes and commit those changes
+
+Now open the project folder to make changes.
+Don't know what to change. Don't worry. 
+Join our discord channel to discuss about the issue and its fix with the community. [Invite link](http://discord.disstreamchat.com).
+Or open the issues tab (right next to code tab) and pickup any `good first issue`. Properly understand the issue and put up a comment 'Assign this issue to me' if you to give a fix this issue.
+
+
+Now, save the file.
+
+
+If you go to the project directory and execute the command `git status`, you'll see there are changes.
+
+
+Add those changes to the branch you just created using the `git add` command:
+
+```
+git add .
+```
+
+Now commit those changes using the `git commit` command:
+```
+git commit -m "Add <your-name> to Contributors list"
+```
+replacing `<your-name>` with your name.
+
+## Push changes to GitHub
+
+Push your changes using the command `git push`:
+```
+git push origin <add-your-branch-name>
+```
+replacing `<add-your-branch-name>` with the name of the branch you created earlier.
+
+## Submit your changes for review
+
+If you go to your repository on GitHub, you'll see a  `Compare & pull request` button. Click on that button.
+
+<img style="float: right;" src="https://raw.githubusercontent.com/firstcontributions/first-contributions/master/assets/compare-and-pull.png" alt="create a pull request" />
+
+Now submit the pull request.
+
+<img style="float: right;" src="https://raw.githubusercontent.com/firstcontributions/first-contributions/master/assets/submit-pull-request.png" alt="submit pull request" />
+
+Soon I'll be merging all your changes into the master branch of this project. You will get a notification email once the changes have been merged.
+
+## Where to go from here?
+
+Congrats!  You just completed the standard _fork -> clone -> edit -> PR_ workflow that you'll encounter often as a contributor!

README.md

@@ -2,43 +2,72 @@
     <a href="https://www.disstreamchat.com"><img src="https://www.disstreamchat.com/logo.png" width=200/></a>
  </p>
 <h1 align="center"> DisStreamChat App </h1>
+<hr/>
+<p align="center">
+<img src="https://img.shields.io/github/license/disstreamchat/app?style=for-the-badge" alt="Stream chat manager"/>
+<img src="https://img.shields.io/github/last-commit/disstreamchat/app?color=%462b45&style=for-the-badge" alt="Stream chat manager" />
+<img src="https://img.shields.io/github/labels/disstreamchat/app/help%20wanted?color=%462b45&style=for-the-badge" alt="Stream chat manager" />
+<img src="https://img.shields.io/github/issues/disstreamchat/app?color=%462b45&style=for-the-badge" alt="Stream chat manager" />
+</p>
+
+<p align="center"><img src="https://media.discordapp.net/attachments/727356806552092675/755062471789641748/unknown.png?width=1923&height=1250"></p>
+
+
+## 🚀 Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
+
+You'll need [Git](https://git-scm.com), [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer, and [yarn](https://yarnpkg.com/)
+
+```
+[email protected] or higher
+[email protected] or higher
+[email protected] or higher
+[email protected] or higher
+```
+
+## 🔧 Installation
+
+From your command line, clone and run the app in development:
+
+```bash
+# Clone this repository
+$ git clone https://github.com/DisStreamChat/App.git
+
+# Go into the repository
+$ cd App
+
+# Install dependencies
+$ npm install
+
+# Run 
+$ npm start
+
+```
 
 ---
-## Support
+## 💵 Support
 
 This project is a part of DisStreamChat. Whether you use this project, another DisStreamChat project, have learned something from it, or just like it, please consider supporting it by becoming a patreon, so we can dedicate more time on more projects like this 😀.
 
 <a href="https://www.patreon.com/disstreamchat?fan_landing=true" target="_blank"><img src="https://cdn.discordapp.com/attachments/727356806552092675/754198973027319868/Digital-Patreon-Wordmark_FieryCoral.png" alt="Patreon" width=200 style="height: auto !important;width: 200px !important;" ></a>
 
-# Framework/Tech use
-* electron
-* React
-* Firebase
+## :technologist: Technologies used
 
-# Contributing
-All contributions and feature requests are welcome. Feel free to make a pull request or open an issue
+- [React](https://reactjs.org/)
+- [Electron](https://www.electronjs.org/)
+- [SCSS](https://sass-lang.com/documentation/syntax) 
+- [Firebase](https://firebase.google.com/)
+- [Material UI](https://material-ui.com/) for icons and inputs
 
-# Installation
+## 📄 License
 
-## Install for Devolopment
-1. Clone this repository.
-```
-git clone https://github.com/DisStreamChat/App.git
-```
-2. Install Dependencies
-```
-npm install
-```
-3. If you havent already, install Yarn globally.
-```
-npm install -g yarn
-```
-4. Create a .env and add enviromnent variables from `.env.sample`. unless you are using a development version of the backend, the socket url should be set to `https://api.disstreamchat.com/`
-6. Run dev server.
-```
-npm run start
-```
+This project is licensed under the MIT License - see the [LICENSE.md](./LICENSE) file for details
 
+# Contributing
+All contributions and feature requests are welcome. Feel free to make a pull request or open an issue. For more info see the [contributing guide](./CONTRIBUTING.md)
 
 
 [![GitHub followers](https://img.shields.io/github/followers/gypsydangerous.svg?label=Follow%20@gypsydangerous&style=social)](https://github.com/gypsydangerous/)  [![Twitter Follow](https://img.shields.io/twitter/follow/disstreamchat?style=social)](https://twitter.com/disstreamchat)
+
+Made with ♥️ by the [DisStreamChat Team](https://www.disstreamchat.com/#/members) and gracious [contributors](https://github.com/DisStreamChat/Contributors)