https://github.com/runo-saduwa/quick-gist-team-a

https://github.com/runo-saduwa/quick-gist-team-a

Last synced: 19 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/runo-saduwa/quick-gist-team-a
• Owner: Runo-saduwa
• Created: 2019-10-14T06:23:42.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-11T09:59:31.000Z (almost 2 years ago)
• Last Synced: 2023-03-03T11:47:25.534Z (over 1 year ago)
• Language: JavaScript
• Size: 2.37 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 15
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# QuickGist Web Forum

QuickGist is a web based chat application which allows unique users to join a chat room/group

and chat/discuss about random topics in real-time. QuickGist allows users connect with ease because there is no authentication built into the application, all that is required to join a group is a unique username. 

The focus of the application is to allow users to engage in "quick" discussions in a modest and decent manner, hence, foul languages or profane words are censored.

 

QuickGist is a single-page application (SPA), it was developed with some of the most popular web technologies on the web.

## Repository

- [QuickGist repo](https://github.com/Runo-saduwa/quick-gist-team-a/)

## Have a feel of the app

- [see the live version](https://quickgist.netlify.com/)

## Getting Started

- Fork or directly clone this repository to your local machine

- Use the `npm install` command to install dependencies in the `/quickgist` directory which include:

  - `concurrently`

  - `nodemon`

- change directory to `/server` directory and use the `npm install` command to install dependencies which include:

  - `Express`

  - `Socket.IO`

  - `CORS`

  - `bad-words`

- change directory to `/client` directory and use the `npm install` command to install dependencies.

  - `React`

  - `socket.io-client`

  - `react-icons`

  - etc

- Once the dependencies are finished installing, change directory back to the root directory

`/quickgist` and use the `npm run dev` command to open the app in your local browser of choice

## Built With

- [Node.JS](https://nodejs.org/)

- [React](https://reactjs.org/)

- [ExpressJS](https://expressjs.com/)

- [Socket.IO](https://socket.io/)

## Authors

- [Runo Saduwa](https://github.com/Runo-saduwa)

- [Joseph Akayesi](https://github.com/JosephAkayesi)