About Chat House

About · How to contribute · How to run · Trello · FAQ

---

This is achived because I dont want to work on it anymore

Structure

Codebase	Description
Breakfast	The sorce code for the client side (TS/React)
Lunch	The sorce code for the server (TS)
Dinner	The sorce code for the API (PY/Flask)
Brunch	Coming Soon (Docs/md)

Branches

Only Ones that Wont go away (Not temporary)

Branch	Description
master/main	The sorce code for the chat app

About

Chat House, is a app for creators. You can make different types of rooms for different purposes!

How to contribute:

• First find something to work on
• Next get it working on you pc (How to run)
• Next fork the repo and work on your fixes/changes/additions
• Now Read How To Commit
  • Using yarn so have that installed
• Make a pr with a title and description
  • To main, from your forked repo Title example:

{User name} {pr index (number of pr you have done in the repo)}

How to run the app

First download the files

$ git clone https://github.com/OreoDivision/chat-house && cd chat-house

This will download the sorce for the chat app

To run the api, go here

Install Node JS && Yarn

To make the server and client work you need nodejs Go here https://nodejs.org/en/

To have clean commands insall YARN Yarn

Now READ THE README.md in both the lunch and breakfast folders