Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mjibson/goread

RSS reader in go on app engine; formerly goread.io
https://github.com/mjibson/goread

Last synced: 3 months ago
JSON representation

RSS reader in go on app engine; formerly goread.io

Awesome Lists containing this project

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](http://www.python.org/download/releases/2.7.5/) and make sure it is in your `PATH`. (Google App Engine doesn't yet work with Python 3.)
1. Install [Git](http://gitscm.com/) and [Mercurial](http://mercurial.selenic.com/wiki/Download) and make sure `git` and `hg` are in your `PATH`.
1. Install the [Go App Engine SDK](https://developers.google.com/appengine/downloads#Google_App_Engine_SDK_for_Go).
1. Set your `GOPATH` (to something like `/home/user`), and make sure it's a directory that exists. (Note: set this on your machine's environment, not in the go.bat file.)
1. Further commands use `goapp` which lives in the `go_appengine` directory from the SDK. Make sure it's in your `PATH`.
1. Download goread and dependencies by running: `goapp get -d github.com/mjibson/goread`. You may get messages about unrecognized imports. Ignore them.
1. `cd $GOPATH/src/github.com/mjibson/goread/app`.
1. Copy `app.sample.yaml` to `app.yaml`.
1. In the `goread` directory (`cd ..` from the command above), copy `settings.go.dist` to `settings.go`.
1. From the `app` 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`.)
1. View at [localhost:8080](http://localhost:8080), admin console at [localhost:8000](http://localhost:8000).

## developer notes

1. Press `alt+c` to show the miniprofiler window.
1. 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.
1. Create a [new app engine application](https://cloud.google.com/console?getstarted=https://appengine.google.com).
1. In `app.yaml`, change the first line to contain the name of the application you just created.
1. From the `app` directory, deploy with `goapp deploy`.