cfpb / idea-box

An application that lets an organization collect ideas, comment on them, and vote them up.
Creative Commons Zero v1.0 Universal
159 stars 49 forks source link

simpler and more updated doc for setup? #61

Closed loell closed 7 years ago

loell commented 10 years ago

seeing activities in recent days, is the documentation for the setup still applicable? I've tried following, the dependencies are mostly met by PIP, and elasticsearch isn't so hard to install. but when incorporating it to a django app, the setup seems puzzling? is there anyway to ease that pain? perhaps prototype app that users can download?

cmc333333 commented 10 years ago

You're right, the README isn't very simple. Will write a patch at some point, but here's the quick version.

To just see the app running (without any particularly styling or searching):

To include the app within an existing django installation, you need to place the src/idea directory with your other django apps (https://github.com/cfpb/idea-box#folder-structure) and add it to your installed apps in the django config.

m3brown commented 10 years ago

It's been overdue for a while, but the README has been cleaned up to reflect the current state of Idea-Box. Notably, elasticsearch is no longer part of the installation process because the "find similar ideas" functionality was phased out of the front end design.