search

codeforamerica / oakland_answers

Code For America's version of Oakland Answers.
10 stars 15 forks source link

suggestion: reconcile readme.md and dev-setup.md #93

Open straz opened 9 years ago

straz commented 9 years ago

Just thought I'd share some issues I had just following the installation guide(s).

  1. README.md and DEV-SETUP.md have conflicting instructions for local setup. These differences need to be resolved.
  2. README.md tells you to view localhost:5000 for your local setup, but DEV-SETUP.md runs on localhost:3000
  3. I tried to install on MacOS Yosemite and encountered these problems with missing dependencies. It would be preferable for the code to check for these dependencies and fail gracefully with an informative error.
    1. Qt needed to be installed. (try brew install qt)
    2. V8 needs to be installed. See this stackoverflow discussion.
    3. Postgres needs to be installed (try brew install postgresql)
  4. You have to generate a secret key (rake secret) and declare it in .env
  5. You have to remove the line require jquery.ui.autocomplete from the file app/assets/javascripts/application.js because even though it looks commented out, it fails to load and halts the server.