Skip to content

Latest commit

 

History

History
174 lines (111 loc) · 4.3 KB

README.md

File metadata and controls

174 lines (111 loc) · 4.3 KB
Raw

Where's Brendan

Personal project for storing Spot GPS data, playing around with it, and displaying it in online. This app runs a web dyno on Heroku and a worker dyno using Celery.

Many thanks to Sinan for helping me get started.

Development setup

Prereqs

  • Clone this project git clone https://github.com/brendanebers/wheresbrendan.git
  • virtualenv
  • PostgreSQL
  • A dash of happiness with a sprinkle of rainbows

VirtualEnv on Mac

  • Install Homebrew
  • Ensure Homebrew apps are in the local PATH by adding the following to ~/.bash_profile:
# Ensure user-installed binaries take precedence
export PATH=/usr/local/bin:$PATH
  • Install Python 2: brew install python
  • Install virtualenv: pip install virtualenv

If virtualenv fails to install with errors about unsupported hash type, try:

brew install openssl
brew link openssl --force
brew uninstall python
brew install python --with-brewed-openssl

Setup the Virtual Environment

In a shell, navigate to wheresbrendan and run

virtualenv

On Mac:

virtualenv .

Now you'll be able to load a clean little environment without mucking with different package versions on your system.

Activate Virtual Environment

You must do this every time you develop in a new shell.

If you're on a *nix, you've got it easy, run:

source bin/activate

If you're an unfortunate soul running Windows cough Brendan cough. You'll need to take care of execution policies (directions here) and then run:

.\Scripts\activate

Installing Packages

Now that you're in a virtual environment, get all the packages!

If you're on Mac, you need to configure the path to pg_config so that the installation of psycopg2 can find it. Assuming you used Postgres.app, add the following to ~/.bash_profile:

PATH="/Applications/Postgres.app/Contents/Versions/9.4/bin:$PATH"

Adjust the path before running pip.

pip install -r requirements.txt

You'll need to do this anytime packages are added to or changed in requirements.txt.

Packages for JS Development

Development on the HTML and JavaScript required npm, bower, and gulp. To get npm on Linux:

apt-get install

Once npm is installed, from a command line run:

npm install -g gulp bower

Inside the JS and HTML directory, app/static, to install the necessary packages:

npm install && bower install

To test the files locally without compiling:

gulp serve

To build the files

gulp

Environment Variables

We don't really want to give you access to our database or let you play with our API keys, so you'll need to supply your own environment variables. See generate_env.py and generate_env.md for a tool to automatically generate environment-specific configuration scripts.

Database

Setting up the Database

After installing the packages and loading your environment variables, create the local database user and database:

createuser -DELSP wheres_admin
createdb -O wheres_admin wheres_local

On Mac, the path to the Postgres utilities will be something like: /Applications/Postgres.app/Contents/Versions/9.4/bin.

Next, initialize the Migrate tables:

python tools/db_create.py

Apply Database Migrations

To apply all of the database migrations that have not been applied to the current database, run:

python db/manage.py upgrade

Model Migrations

You can make changes to the DB model classes and easily generate new database migrations, without having to manually define the tables. Make changes to app/models.py and then run:

python tools/db_migrate_models.py

That will generate a new migration script in db/versions. If you want to test your changes, be certain you are NOT pointing at the live database and run:

python db/manage.py test

Don't forget to apply the migrations, as shown above.

Content of this repository is copyright Brendan Ebers, 2015