ian-cambr / mitra-discourse

A platform for community discussion. Free, open, simple.

Home Page:https://www.discourse.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

FOR MITRA RESEARCH STUDENTS

Set up Virtual Machine and Ubuntu on Windows

  1. Install VirtualBox, this will host the Ubuntu Operating System
  1. Install Ubuntu Package
  1. Set up Ubuntu in VirtualBox (Start video at 1:08 if you followed previous 2 steps) ** IMPORTANT **
  • Recommended allocation of at least 40-50gb of storage for Ubuntu

  • When making a username and password for your VM of Ubuntu make sure to write them down, they will be your login for Ubuntu

  • Follow video below to set up Ubuntu inside VirtualBox

  • https://www.youtube.com/watch?v=rJ9ysibH768

  1. If you do not have sudo access by default run the following commands in terminal
  2. su - - enter password you used in VirtualBox set up
  3. apt-get install sudo - in case sudo isn't installed for some reason
  4. adduser "yourusername" sudo - replace "yourusername" with the username you used in VirtualBox set up
  5. Restart Ubuntu
  • Now you should have sudo access, you can check by running
    • sudo apt update

Set up Local Hosting of Mitra Webpage

  1. Follow Steps in Discourse Guide for Ubuntu Local Hosting ** IMPORTANT **
  1. Updating Github Repository
  • Once you have local host set up, go to your terminal and run the following commands
  1. cd discourse/
  2. git pull
  • this will ensure you have the most up to date version of our local host

Run Local Host

  1. To run local host go to your terminal and run the following commands 1. cd discourse/ 2. ./run.sh
    • If it is your first time running the local host and Ubuntu says you don't have permission run the following command in your terminal
    1. chmod +rx ./run.sh
    • now you should be able to follow the inital steps and run the local host
  • Once the local host is running navigate to in your web browser

Cloning plugins

  1. (in terminal) cd discourse/plugins/
  2. (in terminal) git clone "github repository link"

Set up Theme and Plugin Component

  1. Run your local host and navigate to the website (see ##Run Local Host)
  2. At the top right corner of the website click log in and sign in with your admin account that you created
  3. Now that you're logged in, navigate to admin on the left sidebar and then press the customize tab at the top
  4. Now you should be in the themes tab, under themes press blue install button and find "Material Design Theme" under popular themes
  5. Now click on Material Design Theme and switch the "Color Palette" to "Material Dark"
  6. Next navigate to the Components tab (next to Themes) and press the blue install button
  7. Find "From a github repository" option and paste https://github.com/communiteq/plugin-outlets-theme-component and click install
  8. Now click on "Plug in Outlet Locations" and find "Include component on these themes"
  9. In the drop down menu find and select "Material Design Theme"
  10. Reload your local host and you should have a plug looking button in the top right, when you press it, it will highlight all the areas of the webpage we can add plug ins

Resources for setting up a Cloud VM (Azure or otherwise):

Option 1: Bitnami https://github.com/davidefornelli/azure-discourse

Option 2: Ubuntu VM https://meta.discourse.org/t/setup-discourse-on-azure/89550 https://github.com/discourse/discourse/blob/main/docs/INSTALL-cloud.md https://github.com/discourse/discourse/blob/main/docs/INSTALL-email.md

Discourse

Discourse is the online home for your community. We offer a 100% open source community platform to those who want complete control over how and where their site is run.

Our platform has been battle-tested for over a decade and continues to evolve to meet users’ needs for a powerful community platform. Discourse allows you to create discussion topics and connect using real-time chat, as well as access an ever-growing number of official and community themes. In addition, we offer a wide variety of plugins for features ranging from chatbots powered by Discourse AI to functionalities like SQL analysis using the Data Explorer plugin.

To learn more, visit discourse.org and join our support community at meta.discourse.org.

Screenshots

Discourse 3.1

Boing Boing

X Community

Mobile

Browse lots more notable Discourse instances.

Development

To get your environment set up, follow the community setup guide for your operating system.

  1. If you're on macOS, try the macOS development guide.
  2. If you're on Ubuntu, try the Ubuntu development guide.
  3. If you're on Windows, try the Windows 10 development guide.
  4. If you're looking to use a simpler Docker-based install, try the Docker development guide.

Plugin Development

https://meta.discourse.org/t/developing-discourse-plugins-part-1-create-a-basic-plugin/30515?page=2

If you're familiar with how Rails works and are comfortable setting up your own environment, you can also try out the Discourse Advanced Developer Guide, which is aimed primarily at Ubuntu and macOS environments.

Before you get started, ensure you have the following minimum versions: Ruby 3.2+, PostgreSQL 13, Redis 7. If you're having trouble, please see our TROUBLESHOOTING GUIDE first!

Setting up Discourse

If you want to set up a Discourse forum for production use, see our Discourse Install Guide.

If you're looking for official hosting, see discourse.org/pricing.

Requirements

Discourse is built for the next 10 years of the Internet, so our requirements are high.

Discourse 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 15.7+.

Built With

  • Ruby on Rails — Our back end API is a Rails app. It responds to requests RESTfully in JSON.
  • Ember.js — Our front end is an Ember.js app that communicates with the Rails API.
  • PostgreSQL — Our main data store is in Postgres.
  • Redis — We use Redis as a cache and for transient data.
  • BrowserStack — We use BrowserStack to test on real devices and browsers.

Plus lots of Ruby Gems, a complete list of which is at /main/Gemfile.

Contributing

Build Status

Discourse 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 Discourse:

  1. Please read the complete mission statements on discourse.org. Yes we actually believe this stuff; you should too.
  2. Read and sign the Electronic Discourse Forums Contribution License Agreement.
  3. Dig into CONTRIBUTING.MD, which covers submitting bugs, requesting new features, preparing your code for a pull request, etc.
  4. Always strive to collaborate with mutual respect.
  5. Not sure what to work on? We've got some ideas.

We look forward to seeing your pull requests!

Security

We take security very seriously at Discourse; all our code is 100% open source and peer reviewed. Please read our security guide for an overview of security measures in Discourse, or if you wish to report a security issue.

The Discourse Team

The original Discourse code contributors can be found in AUTHORS.MD. For a complete list of the many individuals that contributed to the design and implementation of Discourse, please refer to the official Discourse blog and GitHub's list of contributors.

Copyright / License

Copyright 2014 - 2023 Civilized Discourse Construction Kit, Inc.

Licensed under the GNU General Public License Version 2.0 (or later); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Discourse logo and “Discourse Forum” ®, Civilized Discourse Construction Kit, Inc.

Accessibility

To guide our ongoing effort to build accessible software we follow the W3C’s Web Content Accessibility Guidelines (WCAG). If you'd like to report an accessibility issue that makes it difficult for you to use Discourse, email accessibility@discourse.org. For more information visit discourse.org/accessibility.

Dedication

Discourse is built with love, Internet style.

About

A platform for community discussion. Free, open, simple.

https://www.discourse.org

License:GNU General Public License v2.0


Languages

Language:Ruby 60.5%Language:JavaScript 27.0%Language:HTML 5.1%Language:Handlebars 4.3%Language:SCSS 3.0%Language:Mustache 0.1%Language:Shell 0.0%Language:CSS 0.0%Language:Procfile 0.0%