README.md
# AppFab
[](https://travis-ci.org/mezis/appfab)
[](https://codeclimate.com/github/mezis/appfab)
[](https://gemnasium.com/mezis/appfab)
[](https://coveralls.io/r/mezis/appfab)
## Kanban, one level up: agility at the product level.
> AppFab helps software product teams build fanstastic apps, by encouraging
> contribution, transparency, participative planning, and emergent
> prioritisation of projects.
It works great for small teams with external stakeholders, or larger teams
(ours is 25 people).
Its goal is not to replace day-to-day tools like Kanbanery or Pivotal
Tracker, but rather a means to let the collective pitch ideas, priorise them
through voting, and follow them through their whole lifecycle.
### Setup
AppFab requires `Ruby 2.1`, `PostgreSQL` and `memcached` to be installed.
With those installed you can setup the application by running: `./bin/setup`
Locally, it is preferable to use [Pow](http://pow.cx/) with to run Appfab, using
the `.dev.io` local domain. If you do not want to use pow, configure `.env`
with `APP_DOMAIN=localhost`. This is because Appfab will make attempts to
redirect you to a canonical domain.
If you want to test SSL redirections, we recommend to use
[tunnels](https://github.com/jugyo/tunnels) in conjunction with Pow--it's the
simplest way to serve SSL locally.
### Usage
Go to [appfab.io](http://appfab.io/) and create your account. Signup is free
and the app is pretty self-explanatory.
As the app is in beta, the hosted version is free for all but aboslutely no
SLA or guarantee of customer support is provided.
### Contributing
Propose or pick an [issue](https://github.com/mezis/appfab/issues), fork,
write tests, write code, refactor, issue a pull request.
Please make sure to
- [mention the issue](https://github.com/features/projects/issues#section-
close-via-commit- message) in your pull request,
- follow existing conventions,
- when in doubt, consult the [Guide](https://github.com/styleguide/ruby).
and be prepared to discuss your solution!
Please always issue pull requests against the `master` branch.
### Licence
AppFab is free software, copyright (c) HouseTrip Ltd.
Its source code is made available to the public under a slightly modified
version of the [AGPL 3](http://www.gnu.org/licenses/agpl-3.0.html) licence,
which:
- comes with extensive copyleft provision like the GPL,
- forces licencees that modify the software to share their modifications here, even if they don't redistribute it.
If you plan to contribute to AppFab, please have a read at LICENCE.md in
this repository.
### Trademark
While neither "AppFab" text mark nor the appfab logo (boldface black letter
"a" on white background) are currently registered in any country, the
original author (Julien T. Letessier) hereby claims both in the context of
NICE categories 9; 38; 41; and 42.
If trademarks mean nothing to you, this is intended to protect the name
"AppFab" and set precedent to avoid trademark squatting and bullying from
trademark trolls.