/firestorm

An open-source forum engine, with an Elixir+Phoenix backend and an Elm frontend.
  1. Elixir 81.8%
  2. JavaScript 7.6%
  3. CSS 5.0%
  4. HTML 3.9%
  5. Elm 1.7%
Elixir JavaScript CSS HTML Elm

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP
Find file
Switch branches/tags
Nothing to show
Latest commit b981c37 May 9, 2017 @tomasz-tomczyk tomasz-tomczyk committed with knewter Fix Twitter link for Tomasz's Kickstarter line (#78)
Permalink
Failed to load latest commit information.
apps Scroll to newest post in thread first (#76) May 4, 2017
config Rework the repo so the app's at the root Feb 23, 2017
design Add missing design meeting links (#54) Apr 11, 2017
.credo.exs Add moduledoc for various modules Feb 26, 2017
.gitignore Make CreateCategory command in the changeset style Feb 26, 2017
.iex.exs Color our categories Feb 27, 2017
CHANGELOG.md Add post previews (#63) Apr 20, 2017
CONTRIBUTING.md Add contribution guidelines and meetings Jan 6, 2017
CONTRIBUTORS.md Add CONTRIBUTORS file Mar 4, 2017
LICENSE Add MIT License Mar 29, 2017
PATRONS.md Fix Twitter link for Tomasz's Kickstarter line (#78) May 9, 2017
Procfile [Procfile] phoenix.server -> phx.server Mar 31, 2017
README.md [DOC] Stupid readme update Apr 20, 2017
compile Fix webpack node env I hope Apr 20, 2017
elixir_buildpack.config Specify elixir, erlang versions Feb 23, 2017
mix.exs Scroll to newest post in thread first (#76) May 4, 2017
mix.lock Scroll to newest post in thread first (#76) May 4, 2017
phoenix_static_buildpack.config Fix a few pointless lines, add phoenix_static_buildpack.config Feb 23, 2017
yarn.lock Get elm emoji picker working, with some jquery Apr 14, 2017

README.md

Firestorm

An open-source forum engine, with an Elixir+Phoenix backend and an Elm frontend.

A community-funded project from DailyDrip.

Build Status Deps Status

This is the Firestorm Forum project. We've just reached the "initial dogfooding" phase and you can view the first deployed version at http://firestorm-dogfood.herokuapp.com.

The design document is a good place to start reading if you're unfamiliar with the project.

Patrons

This project was funded by a Kickstarter.

All of the patrons that made it possible are listed in the PATRONS file.

Code

This is an umbrella app consisting of firestorm_data and firestorm_web.

Features

At present, we're wrapping up the initial design phase. Having said that, here are the planned features and their status:

  • Continuous Integration
    • We're using Semaphore CI for this
  • Continuous Deployment
  • OAuth
    • At present, we only support GitHub. We'll support a lot more services in the future, but until we're happy with the state of the rest of the dogfooding session we'll stick with GitHub.
  • Email (first class!)
    • The goal here is to be a fantastic replacement for Google Groups
  • Forums
  • Topics
    • Stickies
  • Posts
  • Personal Messaging
  • Tags
  • Search
  • Slack Integration
  • Plugin System

Configuration

S3

Attachments are stored on S3. Consequently, you will need to create an S3 bucket to store them, as well as an API user that can write to it and list all of your buckets, and configure the bucket for CORS.

You also need to set 4 environment variables:

export AWS_ACCESS_KEY_ID=XXXX
export AWS_SECRET_ACCESS_KEY=XXXX
export AWS_S3_BUCKET=XXXX
export AWS_S3_REGION=XXXX

CORS configuration

Here's an example CORS configuration:

<?xml version="1.0" encoding="UTF-8"?>
<CORSConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
  <CORSRule>
    <AllowedOrigin>http://localhost:4000</AllowedOrigin>
    <AllowedMethod>POST</AllowedMethod>
    <AllowedHeader>*</AllowedHeader>
  </CORSRule>
  <CORSRule>
    <AllowedOrigin>http://firestorm-dogfood.herokuapp.com</AllowedOrigin>
    <AllowedMethod>POST</AllowedMethod>
    <AllowedHeader>*</AllowedHeader>
  </CORSRule>
</CORSConfiguration>

License

Firestorm is MIT Licensed.