Sign up, and start adding the articles that you have read and want to remember!
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
config
db
img
lib
log
public
test
vendor/assets
.editorconfig
.gitignore
.travis.yml
Gemfile
Gemfile.lock
Procfile
Rakefile
config.ru
encrypt.go
license.md
readme.md

readme.md

cutouts

Sign up, and start adding the articles that you have read and want to remember! Deployed here

Build Status

You can find the Firefox companion add-on here

What?

  • Simple form with just two compulsary questions: Link and a Quote from the article that you want to remember
  • As simple as it can get. Nothing fancy. Vanilla bootstrap. Vanilla font awesome.
  • List public cutouts at profile page
  • Share a single cutout with friends and family by emailing it to them
  • Share a cutout on social media by copying it's permalink

Why?

The internet has a lot of good content, blog posts, articles, etc etc. I read a lot of stuff, and then could not find them again when I wanted to. Pocket is good for saving for later, Delicious and Pinterest are overkill for something as simple. Hence, this project!

Manual Testing

  • login and logout
  • login, add a public cutout, check that it is accessible without login, logout
  • login, add an unlisted cutout, check that it is accessible without login, logout
  • login, add a private cutout, ensure that it isn't accessibly without login, logout
  • edit an cutout's visibility and check if the changes are reflected

Release Notes

v1.0 - 2018-02-07

  • Add, update, delete cutouts

  • Tag cutouts and then search the cutouts in a particular tag

  • List all the cutouts you have stored in the past

  • Export all your cutouts to UTF8 encoded HTML or JSON

  • Share the permalink for an article that has the title of the article, the quote, the author and it's tags

    img

  • Email a Cutout to friends and family (maximum 5 at once)

    img

  • Add an alias while emailing so that recipients know the cutout is from you

  • Display tags as Bootstrap buttons

    img

  • A link to the archives of the page that has the Cutout

  • A companion Firefox add-on to make it easier to Cutout articles from Firefox

TODO (in descending order of priority)

  • Create a good homepage that has a few words about why this project at all
  • User must be able to login with both username as well as email
    • Override devise? (Devise procedure here seems extremely long)
  • Fix the word limit on quote (50 words?)
  • Fix the sign-in and sign-up form UI
  • Fix the horrible UI to make it usable at the very least (copy medium, that interface is too good!)
  • A system to tag articles (single words)
  • A system to search for articles (single search bar, user search, tag search, author search, quote search)
  • Ability for users to export their articles into a Markdown file for local storage (A JSON file for import too?)
  • A rating system for self, no sharing as yet
  • Probably friendship and the ability to follow other users

forthebadge

Code inside this repo is licensed under MIT.

Copyright (c) 2015 Siddharth Kannan All Rights Reserved.