
zven21
Zven
-
An open-source forum engine, with an Elixir+Phoenix backend and an Elm frontend.
A community-funded project from DailyDrip.
This is the Firestorm Forum project. It's presently at version 0.9, nearly ready
for a 1.0 release. You can view the running forum at
.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
- Setup a complete docker and docker-compose installation
- Clone this repository
- Run
docker-compose up -d
to run the containers - Create the database:
docker-compose run firestorm mix ecto.create
- Run the migrations:
docker-compose run firestorm mix ecto.migrate
- 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 git@github.com: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:
-
- We're using Semaphore CI for this
[ ] Continuous Deployment
- With releases, via distillery
- For now, we've got Semaphore pushing to
after each successful build of
master.
[x] 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.
- At present, we only support GitHub. We'll support a lot more services in the
[ ] Email (first class!)
- The goal here is to be a fantastic replacement for Google Groups
- [x] Forums
[x] Topics
- [ ] Stickies
- [x] 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
- [x] Fix timestamps, use moment.js and ISO format / time_abbr helper
- [x] Style pagination on user show
[-] navigation enhancements
[x] threads i'm participating in
- [ ] drill down by category (for category show sidebar)
[x] threads i'm watching
- [ ] drill down by category (for category show sidebar)
[ ] recently viewed
- [ ] drill down by category (for category show sidebar)
- [x] users
- [x] your profile
- [ ] quote button
- [x] 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:
1.0UTF-8 http://localhost:4000 POST * http://firestorm-dogfood.herokuapp.com POST *
License
Firestorm is MIT Licensed.