remindme

package module
v0.0.0-...-969f120 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2014 License: BSD-3-Clause Imports: 5 Imported by: 0

README

RemindMe

I often find my self opening a lot of tabs to URLs I later forget to read. This is usually in the morning after opening up Hacker News. I figured if I had somewhere to stash the URL until later, I could come back and run through a list, reading the content whenever I have time, on any device, regardless of browser being used or syncing features available.

Bookmarks in browsers are, in my opinion, clunky. I want to pop a URL in a box, put in an optional comment, and save it until later. This will then be a list I can read on any device.

Authentication

This is most certainly something that will be implemented in the HTTP system (see below).

CLI

There is a simple CLI tool to demonstrate/test the library's APIs. Feel free to knock your self out with it.

HTTP

Soon an HTTP server will be developed that one can deploy anywhere. This server will serve up a simple (Bootstrap) UI that you can use to add, view and delete URLs from database.

I don't intend on supporting HTTPS directly from the application as I feel NginX off-loading your SSL certificate is the better, safer option.

Database

SQLite3 is the default, with the current, very simple, implementation of Gorm not allowing any other selection yet. This will change if I feel the need or there is deman.

Sharing

I intend on adding a feature which allows people to share their lists in a read-only fashion via the web UI or perhaps an RSS feed.

Likes

Maybe a simple "thumbs up" feature so people can show approval of a particular URL in a shared list?

Encryption

Maybe add encryption into the mix, allowing one to keep a more secure database on their servers. Could be useful, but given the links are public in the first place, might be a waste of time and resources.

Documentation

Index

Constants

This section is empty.

Variables

View Source
var Bookmarks gorm.DB

Functions

func AddBookmark

func AddBookmark(b *Bookmark) (err error)

func BringUpDatabase

func BringUpDatabase(conns string) (err error)

func CloseDatabase

func CloseDatabase() (err error)

func IsValidComment

func IsValidComment(comment string) (err error)

func IsValidUrl

func IsValidUrl(url string) (err error)

func PurgeDatabase

func PurgeDatabase() (err error)

func RemoveBookmark

func RemoveBookmark(b *Bookmark) (err error)

Types

type Bookmark

type Bookmark struct {
	Url     string    `json:"url"`
	Comment string    `json:"comment"`
	Added   time.Time `json:"added"`
}

func NewBookmark

func NewBookmark(url, comment string) (b *Bookmark, err error)

func RetrieveBookmark

func RetrieveBookmark(url string) (b *Bookmark, err error)

Directories

Path Synopsis
cmd
cli

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL