Hello and welcome to the GitHub repo for The DisStreamChat website! This houses all of the content at disstreamchat.com.
- React
- The whole site is written is react. It is a single page web page web app with react router. It is written with functional components and react hooks
- Firebase
The DisStreamChat website is built with react so it is quite easy to run a development server with webpack
These are the steps you will need to take to install it
- Clone The Repo
you can see the cloning/download options if you click the button on the main page labelledClone or Download
or you can clone it directly withgit clone https://github.com/DisStreamChat/Website.git
- cd into the Repo Directory
cd into the directory withcd Website
. If you named the repo something else when you cloned it you will need tocd
into the folder with that name - Install npm dependencies
You can install npm dependencies withnpm i
ornpm install
- Add your environment variables
You will need to create a.env
file for your environment variables the environment variables you will need are shown in the.env.sample
file in the repo. - Start up a development server
Start it up withnpm start
Contributions to this repository encouraged!
Here are the type of contributions we are looking for:
- bug-fixes
- making the code easier to read (including code comments!)
- website design improvements
- adding any missing content
- responsiveness improvements
To make a contribution, just fork this repository and create a pull request.
If you are just editing a single file, you may click the pencil when viewing the file to edit in the browser.
If you want to give feedback or need help with a problem feel free to make an issue here on github or join our discord
The site welcomes contributions from the community in a variety of ways! For more information see CONTRIBUTING.md and INSTALLATION.md. Suggestions are also welcome in the form of an issue.
If you need help either with an issue using the site or making a contribution feel free to make an issue and we will get to it as soon as we can. You can also get help and give feedback on our discord