discore

Discore

npm install discore
3 downloads in the last week
6 downloads in the last month

Discore

The goal of this project is to create a "core" platform for creating online communities. You then fork this repository and apply your own changes to your own site.

Discore is split into two main parts: this repository which is just the website, and discore-interface which can be considered the "model". The programming interface allows you to create bots and workers without the overhead of the website.

For a live demo, view Funraise.me! - requires a donation to use all the features.

Documentation

Setting up

Binaries

  • Node.js >= 0.10
  • MongoDB >= 2.2
  • ImageMagick

API keys

Currently, Discore won't work without the following API keys. These can either be set in discore-interface/settings/variables.js (not this repository) or through environmental variables.

  • images.s3 - Amazon S3 key, secret, and bucket for uploading images
  • embedly - Embedly API key for links
  • mailer - Email settings

Environment parameters

  • VARIABLES - configuration file that changes between environments as noted above. The purpose is to save your own variables.js file somewhere and set its path as an environmental variable instead of setting 20 environmental variables during development.
  • NODE_ENV - production, stage, or, by default, development
  • PORT - by default 3000

settings/variables.js has more environmental parameters you may be interested in.

Make

  • make install - installs everything local and builds the assets
  • make - build the CSS and JS
  • make release - build the CSS and JS and push to /public. Assets are hashed, so you don't ever need to worry about versioning them.
  • make clean - removes all derivative files

Run

  • node . - default port 3000
  • VARIABLES=../variables.js PORT=80 node . - saving all your environmental variables in a single file instead of exporting them

Tests

Tests in this repository are only for the actual website. There are currently no HTML tests.

  • node tests for testing the JSON API. Assumes the server is running on http://localhost with port PORT or, by default, 3000.

Discussion

/r/discore

Help fund development by donating to Funraise.me!. As Funraise.me! is a tax-exempt US charity, all donations are tax deductible.

License

Discore Copyright (C) 2013 Funraise.me! team@funraise.me

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

npm loves you