goapp

package module
v0.0.0-...-a881c56 Latest Latest
Warning

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

 Go to latest Published: Dec 16, 2013 License: ISC Imports: 47 Imported by: 0

README

go read

a google reader clone built with go on app engine and angularjs

setting up a local dev environment

  1. Install Python 2.7 and make sure it is in your PATH. (Google App Engine doesn't yet work with Python 3.)
  2. Install Git and Mercurial and make sure git and hg are in your PATH.
  3. Install the Go App Engine SDK.
  4. Set your GOPATH (to something like /home/user/mygo), and make sure it's a directory that exists. (Note: set this on your machine's environment, not in the go.bat file.)
  5. Further commands use goapp which lives in the go_appengine directory from the SDK. Make sure it's in your PATH.
  6. Download dependencies by running: goapp get -d github.com/mjibson/goread. This will download goread and all of its dependencies, and will stick them in your GOPATH.
  7. cd $GOPATH/src/github.com/mjibson/goread.
  8. git checkout master (bug in go get).
  9. Copy app.sample.yaml to app.yaml.
  10. In the goread directory, copy settings.go.dist to settings.go.
  11. From the goread directory, start the app with goapp serve. (On Windows, you may need to do this instead: python C:\go_appengine\dev_appserver.py app.yaml.)
  12. View at localhost:8080, admin console at localhost:8000.

developer notes

  1. Press alt+c to show the miniprofiler window.
  2. Press c to clear all feeds and stories, remove all your subscriptions, and reset your unread date.

self host on production app engine servers

  1. Set up a local dev environment as described above.
  2. Create a new app engine application.
  3. In app.yaml, change the first line to contain the name of the application you just created.
  4. From the goread directory, deploy with goapp deploy.

Documentation

Index

Constants

View Source 
const (
	AFree = iota
	ADev
	APaid
)
View Source 
const IDX_COL = "c"
View Source 
const IMPORT_LIMIT = 10

Variables

View Source 
var (
	Angular      string
	BootstrapCss string
	BootstrapJs  string
	FontAwesome  string
	Jquery       string
	JqueryUI     string
	Underscore   string
)
View Source 
var ErrNoRssLink = errors.New("No rss link found")

Functions

func Account 

func Account(c mpg.Context, w http.ResponseWriter, r *http.Request)

func AddSubscription 

func AddSubscription(c mpg.Context, w http.ResponseWriter, r *http.Request)

func AdminDateFormats 

func AdminDateFormats(c mpg.Context, w http.ResponseWriter, r *http.Request)

func AdminFeed 

func AdminFeed(c mpg.Context, w http.ResponseWriter, r *http.Request)

func AdminStats 

func AdminStats(c mpg.Context, w http.ResponseWriter, r *http.Request)

func AdminSubHub 

func AdminSubHub(c mpg.Context, w http.ResponseWriter, r *http.Request)

func AdminUpdateFeed 

func AdminUpdateFeed(c mpg.Context, w http.ResponseWriter, r *http.Request)

func AdminUser 

func AdminUser(c mpg.Context, w http.ResponseWriter, r *http.Request)

func AllFeeds 

func AllFeeds(c mpg.Context, w http.ResponseWriter, r *http.Request)

func AllFeedsOpml 

func AllFeedsOpml(c mpg.Context, w http.ResponseWriter, r *http.Request)

func Autodiscover 

func Autodiscover(b []byte) (string, error)

func Charge 

func Charge(c mpg.Context, w http.ResponseWriter, r *http.Request)

func ClearFeeds 

func ClearFeeds(c mpg.Context, w http.ResponseWriter, r *http.Request)

func DeleteAccount 

func DeleteAccount(c mpg.Context, w http.ResponseWriter, r *http.Request)

func ExportOpml 

func ExportOpml(c mpg.Context, w http.ResponseWriter, r *http.Request)

func FeedHistory 

func FeedHistory(c mpg.Context, w http.ResponseWriter, r *http.Request)

func GetContents 

func GetContents(c mpg.Context, w http.ResponseWriter, r *http.Request)

func GetFeed 

func GetFeed(c mpg.Context, w http.ResponseWriter, r *http.Request)

func GetStars 

func GetStars(c mpg.Context, w http.ResponseWriter, r *http.Request)

func ImportOpml 

func ImportOpml(c mpg.Context, w http.ResponseWriter, r *http.Request)

func ImportOpmlTask 

func ImportOpmlTask(c mpg.Context, w http.ResponseWriter, r *http.Request)

func ListFeeds 

func ListFeeds(c mpg.Context, w http.ResponseWriter, r *http.Request)

func LoginGoogle 

func LoginGoogle(c mpg.Context, w http.ResponseWriter, r *http.Request)

func Logout 

func Logout(c mpg.Context, w http.ResponseWriter, r *http.Request)

func Main 

func Main(c mpg.Context, w http.ResponseWriter, r *http.Request)

func MarkRead 

func MarkRead(c mpg.Context, w http.ResponseWriter, r *http.Request)

func MarkUnread 

func MarkUnread(c mpg.Context, w http.ResponseWriter, r *http.Request)

func ParseFeed 

func ParseFeed(c appengine.Context, origUrl, fetchUrl string, b []byte) (*Feed, []*Story, error)

func SaveOptions 

func SaveOptions(c mpg.Context, w http.ResponseWriter, r *http.Request)

func SetStar 

func SetStar(c mpg.Context, w http.ResponseWriter, r *http.Request)

func SubscribeCallback 

func SubscribeCallback(c mpg.Context, w http.ResponseWriter, r *http.Request)

func SubscribeFeed 

func SubscribeFeed(c mpg.Context, w http.ResponseWriter, r *http.Request)

Task used to subscribe a feed to push.

func Uncheckout 

func Uncheckout(c mpg.Context, w http.ResponseWriter, r *http.Request)

func UpdateFeed 

func UpdateFeed(c mpg.Context, w http.ResponseWriter, r *http.Request)

func UpdateFeedLast 

func UpdateFeedLast(c mpg.Context, w http.ResponseWriter, r *http.Request)

func UpdateFeeds 

func UpdateFeeds(c mpg.Context, w http.ResponseWriter, r *http.Request)

func UploadOpml 

func UploadOpml(c mpg.Context, w http.ResponseWriter, r *http.Request)

Types

type Feed 

type Feed struct {
	Url        string        `datastore:"-" goon:"id"`
	Title      string        `datastore:"t,noindex"`
	Updated    time.Time     `datastore:"u,noindex" json:"-"`
	Date       time.Time     `datastore:"d,noindex" json:"-"`
	Checked    time.Time     `datastore:"c,noindex"`
	NextUpdate time.Time     `datastore:"n"`
	Link       string        `datastore:"l,noindex" json:"-"`
	Hub        string        `datastore:"h,noindex" json:"-"`
	Errors     int           `datastore:"e,noindex"`
	Image      string        `datastore:"i,noindex"`
	Subscribed time.Time     `datastore:"s,noindex" json:"-"`
	Average    time.Duration `datastore:"a,noindex" json:"-"`
	LastViewed time.Time     `datastore:"v,noindex" json:"-"`
	NoAds      bool          `datastore:"o,noindex" json:"-"`
	// contains filtered or unexported fields
}

func (*Feed) IsSubscribed 

func (f *Feed) IsSubscribed() bool

func (*Feed) NotViewed 

func (f *Feed) NotViewed() bool

func (*Feed) PubSubURL 

func (f *Feed) PubSubURL() string

func (*Feed) Subscribe 

func (f *Feed) Subscribe(c appengine.Context)

type Image 

type Image struct {
	Id   string            `datastore:"-" goon:"id"`
	Blob appengine.BlobKey `datastore:"b,noindex"`
	Url  string            `datastore:"u,noindex"`
}

type Includes 

type Includes struct {
	Angular             string
	BootstrapCss        string
	BootstrapJs         string
	FontAwesome         string
	Jquery              string
	JqueryUI            string
	Underscore          string
	MiniProfiler        template.HTML
	User                *User
	Messages            []string
	GoogleAnalyticsId   string
	GoogleAnalyticsHost string
	SubURL              string
	IsDev               bool
	IsAdmin             bool
	StripeKey           string
	StripePlans         []Plan
}

type Log 

type Log struct {
	Id     int64          `datastore:"-" goon:"id"`
	Parent *datastore.Key `datastore:"-" goon:"parent"`
	Text   string         `datastore:"t,noindex"`
	// contains filtered or unexported fields
}

type Opml 

type Opml struct {
	XMLName string         `xml:"opml"`
	Version string         `xml:"version,attr"`
	Title   string         `xml:"head>title"`
	Outline []*OpmlOutline `xml:"body>outline"`
}

type OpmlOutline 

type OpmlOutline struct {
	Outline []*OpmlOutline `xml:"outline" json:",omitempty"`
	Title   string         `xml:"title,attr,omitempty" json:",omitempty"`
	XmlUrl  string         `xml:"xmlUrl,attr,omitempty" json:",omitempty"`
	Type    string         `xml:"type,attr,omitempty" json:",omitempty"`
	Text    string         `xml:"text,attr,omitempty" json:",omitempty"`
	HtmlUrl string         `xml:"htmlUrl,attr,omitempty" json:",omitempty"`
}

type Plan 

type Plan struct {
	Id, Name, Desc string
	Amount         int
}

type Read 

type Read map[readStory]bool

type Stories 

type Stories []*Story

func (Stories) Len 

func (s Stories) Len() int

func (Stories) Less 

func (s Stories) Less(i, j int) bool

func (Stories) Swap 

func (s Stories) Swap(i, j int)

type Story 

type Story struct {
	Id           string         `datastore:"-" goon:"id"`
	Parent       *datastore.Key `datastore:"-" goon:"parent" json:"-"`
	Title        string         `datastore:"t,noindex"`
	Link         string         `datastore:"l,noindex"`
	Created      time.Time      `datastore:"c"`
	Published    time.Time      `datastore:"p,noindex" json:"-"`
	Updated      time.Time      `datastore:"u,noindex" json:"-"`
	Date         int64          `datastore:"e,noindex"`
	Author       string         `datastore:"a,noindex" json:",omitempty"`
	Summary      string         `datastore:"s,noindex"`
	MediaContent string         `datastore:"m,noindex" json:",omitempty"`
	// contains filtered or unexported fields
}

parent: Feed, key: story ID

type StoryContent 

type StoryContent struct {
	Id         int64          `datastore:"-" goon:"id"`
	Parent     *datastore.Key `datastore:"-" goon:"parent"`
	Content    string         `datastore:"c,noindex"`
	Compressed []byte         `datastore:"z,noindex"`
	// contains filtered or unexported fields
}

parent: Story, key: 1

type StripeCustomer 

type StripeCustomer struct {
	Id      string `json:"id"`
	Created int64  `json:"created"`
	Card    struct {
		Last4 string `json:"last4"`
	} `json:"active_card"`
	Subscription struct {
		Plan struct {
			Interval string `json:"interval"`
			Id       string `json:"id"`
			Amount   int    `json:"amount"`
		} `json:"plan"`
		End int64 `json:"current_period_end"`
	} `json:"subscription"`
}

type StripeError 

type StripeError struct {
	Error struct {
		Message string `json:"message"`
	} `json:"error"`
}

type User 

type User struct {
	Id       string    `datastore:"-" goon:"id"`
	Email    string    `datastore:"e"`
	Messages []string  `datastore:"m,noindex"`
	Read     time.Time `datastore:"r"`
	Options  string    `datastore:"o,noindex"`
	Account  int       `datastore:"a"`
	Created  time.Time `datastore:"d"`
	Until    time.Time `datastore:"u"`
	// contains filtered or unexported fields
}

func (*User) String 

func (u *User) String() string

type UserCharge 

type UserCharge struct {
	Id     int64          `datastore:"-" goon:"id"`
	Parent *datastore.Key `datastore:"-" goon:"parent"`

	Customer string    `datastore:"c,noindex" json:"-"`
	Created  time.Time `datastore:"r,noindex"`
	Last4    string    `datastore:"l,noindex" json:"-"`
	Next     time.Time `datastore:"n,noindex"`
	Amount   int       `datastore:"a,noindex"`
	Interval string    `datastore:"i,noindex"`
	Plan     string    `datastore:"p,noindex"`
	// contains filtered or unexported fields
}

parent: User, key: 1

type UserData 

type UserData struct {
	Id     string         `datastore:"-" goon:"id"`
	Parent *datastore.Key `datastore:"-" goon:"parent"`
	Opml   []byte         `datastore:"o,noindex"`
	Read   []byte         `datastore:"r,noindex"`
	// contains filtered or unexported fields
}

parent: User, key: "data"

type UserOpml 

type UserOpml struct {
	Id         int64          `datastore:"-" goon:"id"`
	Parent     *datastore.Key `datastore:"-" goon:"parent"`
	Opml       []byte         `datastore:"o,noindex"`
	Compressed []byte         `datastore:"z,noindex"`
	// contains filtered or unexported fields
}

parent: User, key: time.Now().UnixNano()

type UserStar 

type UserStar struct {
	Id      string         `datastore:"-" goon:"id"`
	Parent  *datastore.Key `datastore:"-" goon:"parent"`
	Created time.Time      `datastore:"c"`
	// contains filtered or unexported fields
}

parent: UserStarFeed, key: Story.Key.Encode()

type UserStarFeed 

type UserStarFeed struct {
	Id     string         `datastore:"-" goon:"id"`
	Parent *datastore.Key `datastore:"-" goon:"parent"`
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
Package atom defines XML data structures for an Atom feed.
 Package atom defines XML data structures for an Atom feed.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.