Skip to content

Latest commit

 

History

History
148 lines (119 loc) · 4.26 KB

README.md

File metadata and controls

148 lines (119 loc) · 4.26 KB
Raw

Firestorm

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

A community-funded project from DailyDrip.

Build Status

This is the Firestorm Forum project. It's presently at version 0.10, nearly ready for a 1.0 release. You can view the running forum at http://forum.firestormforum.org.

Patrons

This project was funded by a Kickstarter.

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

Development

Using Docker

  1. Setup a complete docker and docker-compose installation
  2. Clone this repository
  3. Run docker-compose up -d to run the containers
  4. Create the database: docker-compose run firestorm mix ecto.create
  5. Run the migrations: docker-compose run firestorm mix ecto.migrate
  6. Visit localhost:4000 to see firestorm running.

You can also run docker-compose logs -f firestorm to see the server logs.

Without Docker/native setup

Here are some basic steps to get Firestorm running

git clone [email protected]:dailydrip/firestorm.git
cd firestorm/
# Set the following environment variables
# AWS_ACCESS_KEY_ID=TKTK
# AWS_SECRET_ACCESS_KEY=TKTK
# AWS_S3_BUCKET=TKTK
# AWS_S3_REGION=TKTK
# GITHUB_CLIENT_ID=TKTK
# GITHUB_CLIENT_SECRET=TKTK
# SENDGRID_API_KEY=TKTK
# config postgres in config/database.yml
# start postgres
mix deps.get
mix ecto.create
mix ecto.migrate
cd assets && npm install
cd ../
mix phx.server

Features

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
  • Mentions
  • Documentation
    • Example Project
    • Quickstart / Setup Guide
    • Docs for systems integrating with firestorm within the same BEAM vm
  • Tags
  • Search
  • Slack Integration
  • Plugin System
  • Custom Profile Fields

Quick Fixes

  • Fix timestamps, use moment.js and ISO format / time_abbr helper
  • Style pagination on user show
  • [-] navigation enhancements
    • threads i'm participating in
      • drill down by category (for category show sidebar)
    • threads i'm watching
      • drill down by category (for category show sidebar)
    • recently viewed
      • drill down by category (for category show sidebar)
    • users
    • your profile
  • quote button
  • replying via email
  • reactions / emoji picker
  • tags

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.