Forum Thread is the 100% open source discussion platform built for the next decade of the Internet. Use it as a:
- mailing list
- discussion forum
- long-form chat room
To learn more about the philosophy and goals of the project, visit opensource.learnforcause.com.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Download Node LTS version here: https://nodejs.org/en/download/
- Download VSCode from here: https://code.visualstudio.com/
- Install both before continuing
- Open Visual Studio Code (Referred to as VSCode)
- In the left side bar, click the square icon to open the extensions menu
- Install the extensions:
- Prettier
- EditorConfig for VSCode
- Visual Studio Intellicode
- ESLint
- After installing ESLint, go into its settings by clicking the cog in it’s listing in the extenstion tab, and clicking ‘Configure Extenstion Settings’
- In here, enable auto fix on save. Once thats done, close the ESLint tab that is open, and press Command-Shift-P on Mac, or Ctrl-Shift-P on windows, and type ‘Git Clone’ into the box that appears and hit enter.
- In the box that then comes up, enter: https://github.com/Learn-For-Cause/discuss-thread
- Then press enter, then once that is done, click open in the bottom right.
- Open up a new teminal and type
npm installand hit enter. - Inside
configfolder createconfig.jsfile and copy paste the content fromconfig.example.js( Contact to admin team@learnforcause.com for the Mongodb URI and initialise bothdbanddb_devvariables with it. ) - Once that finshes, the project is ready to go :)
- Start the web page and server by typing
npm startinto terminal. - The site is now available at http://localhost:8080/
To get your environment setup, follow the community setup guide for your operating system.
- If you're on macOS, try the macOS development guide.
- If you're on Ubuntu, try the Ubuntu development guide.
- If you're on Windows, try the Windows 10 development guide.
If you're familiar with how React.js works and are comfortable setting up your own environment, you can also try out the Forum Thread Advanced Developer Guide, which is aimed primarily at Ubuntu and macOS environments.
Forum Thread is built for the next 10 years of the Internet, so our requirements are high.
Forum Thread supports the latest, stable releases of all major browsers and platforms:
| Browsers | Tablets | Phones |
|---|---|---|
| Apple Safari | iPadOS | iOS |
| Google Chrome | Android | Android |
| Microsoft Edge | ||
| Mozilla Firefox |
Additionally, we aim to support Safari on iOS 12.5+ until January 2023 (Forum Thread 3.0).
Before contributing go through the wire frame of the project and raise comments if you have any quaries, visit the Wire Frame here!
Forum Thread is 100% free and open source. We encourage and support an active, healthy community that accepts contributions from the public – including you!
Before contributing to Forum Thread:
- Please read the complete mission statements on opensource.learnforcause.com. Yes we actually believe this stuff; you should too.
- Read and sign the Electronic Discourse Forums Contribution License Agreement.
- Dig into CONTRIBUTING.MD, which covers submitting bugs, requesting new features, preparing your code for a pull request, etc.
- Always strive to collaborate with mutual respect.
- Not sure what to work on? We've got some ideas.
We look forward to seeing your pull requests!
The original Forum Thread code contributors can be found in AUTHORS.MD. For a complete list of the many individuals that contributed to the design and implementation of Forum Thread, please refer to the official Discourse blog and GitHub's list of contributors.
- Asutosh Das - initial work - Asutosh Das
- Sambid Anand Bharadwaj - initial work - Sambid Anand Bharadwaj
Enjoy! Give us feedback if you have suggestions on how to improve this information.
Thanks to these wonderful people ✨✨:
|
|