Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 3.4 KB

README.md

File metadata and controls

62 lines (42 loc) · 3.4 KB
Raw

DisStreamChat Website

License: MIT
Hello and welcome to the GitHub repo for The DisStreamChat website! This houses all of the content at disstreamchat.com.

Tech/framework used

  • React
    • The whole site is written in React. It is a single page web page web app with React router. It is written with functional components and React hooks
  • Firebase

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 patron, so we can dedicate more time on more projects like this. 😀

Patreon

Installation

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.

If you're willing to use the Gitpod Ready-to-Code service, skip to step fourth.

  1. Clone the repository you can see the cloning/download options if you click the button on the main page labelled Clone or Download or you can clone it directly with git clone https://github.com/DisStreamChat/Website.git
  2. cd into the Repo Directory
    cd into the directory with cd Website. If you changed the repository's name when you cloned it, you will need to cd into the folder with that name
  3. Install NPM dependencies
    You can install NPM dependencies with npm i or npm install
  4. 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.
  5. Start up a development server
    Start it up with npm start

Contributing

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, implement your changes, 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.

Feedback and help

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 server.

More on Contributing and Installation

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.

Getting help

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 server.