ceseale / bookup

Project Name

Pithy project description

Team

• Product Owner: Fawn
• Scrum Master: Yifeng
• Development Team Members: Soroush, Colin

Table of Contents

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

Usage

Some usage instructions

Requirements

• Node 0.10.x
• Redis 2.6.x
• Postgresql 9.1.x
• etc
• etc

Development

Installing Dependencies

From within the root directory:

sudo npm install -g bower
npm install
bower install

Greenfield Group

Waffle.io

https://waffle.io/hard-cover/bookup

git-hub group

https://github.com/hard-cover

Greenfield deployment

https://bookups.herokuapp.com

Legacy

• many users don't have usernames, so we need to allow them to add a name that they can display to our DB
• logout functionality: implement sessions (right now, we just use incognito windows to login multiple people and test /users with postman)
• refactor server side controllers to have a utils file
• grab top rated read books to create favorites section
• setup local heroku web environment so that it uses the correct env. variables and callback.
• If you want a diagram of the file system, ask Fawn and she'll email it to you.

jQuery plugin

We began to look into implementing the BookBlock jQuery plugin to get a page flipping effect when someone "flips" a potential match. (We also imagined a bookmarking effect for bookmarking.) You can read up on the plugin here: http://tympanus.net/Development/BookBlock/index.html Note that the js and css bookblock files are already in client/lib and in the index.html, but additional components may need to be inserted. There is also commented out code in the index.html for testing the jQuery plugin.

.env

The .temp.env should be renamed to .env and you should fill in the github username you're using for heroku, along with the consumerkey and consumer secret which we will provide to you. The database URL.... The .env file is for use with heroku local web, but it doesn't work--check out the notes in the auth-config file as well for our thoughts on how to deploy locally. For online deployment, just make sure you setup the config variables in your online account settings. As for the database URL, you'll want to create your own local db url. More info here:

Issues

• Bower vs Heroku: Note that bower was originally used to dl angular and jquery but it wouldn't deploy correctly, so we hard coded them into the html. However, the HIR Sarah advised us that what we need to do is use a .bowerrc file and add a bower script to the npm start script. We've done these things, but the cdn in the index needs to be switched to a relative path in the root folder, and then tested.