tiy-durham-q3-rails / freeshelf Goto Github PK

View Code? Open in Web Editor NEW

3.0 2.0 13.0 44.36 MB

A network for sharing free programming books.

License: MIT License

Ruby 57.71% CoffeeScript 0.84% CSS 40.78% JavaScript 0.67%

freeshelf's Introduction

Freeshelf

This Rails application provides a way to share and collect free programming books.

Installation and usage

This application uses Postgres, so you will need it installed on your machine. If on Linux, use your package manager. On OS X, if you have Homebrew, run brew install postgresql.

Once you have Postgres installed, edit config/database.yml -- or set up Postgres to have a database called freeshelf_development for your current user.

Next, install all required gems:

bundle install

Finally, set up the database:

rake db:create db:migrate db:seed

After that, you can run rails server to start the server or rails console for a REPL.

Testing

You must have PhantomJS installed to run the tests. On OS X with Homebrew, run:

brew install phantomjs

Contributing

If you are new to using git and GitHub, follow these directions:

Fork the project.
Clone your copy.
Add another remote:
git remote add upstream https://github.com/tiy-durham-q3-rails/freeshelf.git
Make a local branch for your feature.
Write code.
Test it out.
Run git fetch upstream and then git merge upstream/master in your branch.
Test again.
Push your branch to your repo.
Make a pull request!

freeshelf's People

Contributors

Stargazers

Watchers

Forkers

jjlangholtz rscottbradshaw ichus sebarmano michaelbyrd maebeale ernbrn chetcorey cndreisbach andrewhooge briardes oke-anyanwu

freeshelf's Issues

Add truncate to descriptions

I talked to you about this yesterday all i would need to add truncate(300) to line 14 in the _book.html.slim partial.

Users need a page with all their favorite books

Easy-peasy, right? These books should be sortable like all lists of books.

We need much better URLs

Everywhere on the site that we use a numeric ID -- right now, for books, but soon, maybe for users and videos -- we should have a nice friendly ID instead. URLs should look more like:

/books/objects-on-rails

We should have videos on the site, too

What about great conference talks? Let's add the ability to link to videos.

Videos can be favorited and tagged, of course.

If the video is from YouTube or Vimeo or is embeddable, let's embed it.

Add edit permissions to videos

The permissions added to books in #40 should be added to videos.

Create decent error for no password on password reset

We need better author support

Books should be able to have multiple authors (0 to n). Those authors should have individual author pages where you can see all books they have on the site.

The interface for adding authors could use a nested form with something like Cocoon to add more authors or something more simple like we do with tags.

If we add videos (#7), they should have speakers who use the same model as authors so we can see all the books and videos from one person.

Users should be able to see Freeshelf in their own language

Don't freak out, you don't have to translate it unless you are fluent in another language.

However, all user-facing text should use Rails' internationalization (i18n) facilities so we can add more languages in the future.

Books should be able to be sorted

They should be able to be sorted by the amount of favorites, the date added to the site, the publication year, or alphabetically.

People should be able to upvote books

Either that, or maybe rate them on a 1-5 scale.

People should be able to leave comments on books

Each book should have a comment area where users can leave comments.

We need a JSON API

All URLs on the site that are public should have a JSON response type so people can get information about books from wherever.

Users should be able to _optionally_ get an email when a new book is added to one of their favorite tags

Emphasis on optional. No one likes spam. This email should let the user know that a book has just been added to the site that has one of their favorite tags on it.

Figure out UI for suggesting email hints on password reset form

People should be able to see books that are recommended for them

These are books that are not their current favorites, but are favorites of people who have similar favorites to them.

Users should be able to see all books that are tagged with their favorite tags

This would be a book listing page like the index or the tags page. Ideally, we could sort these books by how many tags they match.

Books should have tags

These tags would help us find related books.

Now that we have a link for videos on the sidebar I think it makes more sense to rename 'Home' to 'Books'. Perhaps a better alternative would be to have 'Home' index all books and videos and add a 'Books' link to index books.

Thoughts?

Bug: Carolina Clinic site not loading

As a user, when I try to access carolinaclinic.pushactive.com for any browser it does not load...just says the web page is not available. It worked fine until 9 am 10/3/2014.

We need an admin interface to manage the site

We need to install and set up ActiveAdmin. We should have a dashboard that shows the latest books added and the most used tags, at a minimum.

People should have favorite books and tags

Users should have an interface to choose their favorite books. Once we reach an overwhelming amount of books, this will be useful for people to find the books they want.

In addition, they should have favorite tags, and have a way to see all books for their favorite tags.

Add Procfile for Heroku

We need edit permissioning

This could get really complicated, but for now:

All users can add a new book
All users can change the tags on a book
No users can edit an existing book except to change the tags on it

Bug: Comma removed when user edits tag

Notes:

When editing tags, commas are removed

Users should be able to see new books that are tagged with their favorite tags

Users should have a page that shows them all the books that have been added with one or more of their favorite tags since they last looked at the list. We'll need to save when they last looked at the list, of course.

We need to mass-import books

There's a great list of free programming books on GitHub in Markdown. It's formatted in a regular way, so we should be able to parse it and get all the books and URLs out of it.

We need a Rake task (or script) that will pull down this file and read out all the books and load them into the DB. If possible, we should be able to run it over and over and not create duplicate books. We could use the book URL as a unique identifier.