simpler and more updated doc for setup?
loell opened this issue · comments
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?
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):
- pip install zc.buildout
- buildout
- ./bin/django syncdb --migrate
- create an admin user
- ./bin/django runserver
- Go to http://127.0.0.1:8000/admin to log in
- Return to http://127.0.0.1:8000/
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.
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.