thesecrettoiletsofsf

An app that finds you all the closest free public toilets.

Team

• Product Owner: Brandon B
• Scrum Master: Andrew N
• Development Team Members: Brandon B, Andrew N, Brian L

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Tasks
4. Team
5. Contributing

Usage

Some usage instructions

Requirements

• Node 4.x
• Redis 2.6.x
• Postgresql 9.1.x

Development

Installing Dependencies

From within the root directory:

sudo npm install -g bower
npm install
bower install

Running the app on local server

To run the app on your local server:

1. Derive an API key from Google Maps JavaScript API
2. Setup a postgres database on your local machine

Setting up the API

Assuming you have an API key in hand, go to config.js under the client directory and replace YOUR_API_KEY_HERE with your key.

Setting up postgresql database

Run

$ brew install postgresql

Then, to start the postgre server, run

$ pg_ctl -D /usr/local/var/postgres -l /usr/local/var/postgres/server.log start

Then, create the a database by running

createdb gottago

After you have created a new database, you need to make a .bash_profile in the root directory and declare the following variables.

# .bash_profile
export DATABASE='<database you created>'
export DATABASE_USERNAME='<username you created the database with>'
export DATABASE_SERVER='localhost'
export DATABASE_PASSWORD='<your password if you created one>'

After saving the .bash_profile, you can try to start the server by running

$ source .bash_profile
$ npm start

Make sure to run source .bash_profile first, otherwise none of the environment variables will exist and the database connection will no established properly. By default, you can access the app at http://localhost:8080.

When finished, stop the postgres server by running

pg_ctl -D /usr/local/var/postgres stop -s -m fast

Roadmap

View the project roadmap at waffle.io

Contributing

See CONTRIBUTING.md for contribution guidelines.