Skip to content

bobinette/papernet

Repository files navigation

Build Status

Papernet

Papernet is a very simple tool to keep track of the papers you read.

Setup

Go

Usual go installation (1.7.5)

I use the gvm, but you can install golang any way you prefer

bash < <(curl -s -S -L https://raw.githubusercontent.com/moovweb/gvm/master/binscripts/gvm-installer)
gvm install go1.7.5 --binary

then add the following to your bashrc (or the equivalent for your terminal)

source $HOME/.gvm/scripts/gvm
gvm use go1.7.5
export GOPATH=/path/to/go
export PATH=$PATH:$GOROOT/bin:$GOPATH/bin

Dependencies

The dependencies are handled with godep:

go get -u github.com/kardianos/govendor/...
govendor sync

Auth

Key file

You need to generate your shared secret for the authentication. You can use this site to do so: https://mkjwk.org/, with the following settings: image You decide what you want to use as key ID

Google oauth

If you want to use Google to handle the auth, you need credentials for the project. Follow the instructions here: https://developers.google.com/identity/protocols/OAuth2, to create those credentials.

If you do not want to use google for oauth, you can simply set enabled=false in the configuration file and use the simple email/password login system. It does not include email confirmation or password reset, but it will avoid you having to register Papernet on Google.

Web server

To start the web server, you have to create the data folder, and setup the index:

mkdir data
go run cmd/cli/*.go index create --index=data/papernet.index --mapping=bleve/mapping.json

Now that everything is ready, you can start the server:

go run cmd/web/main.go

Front-end

This repository contains the backend of the Papernet project, for the front-end check out https://github.com/bobinette/papernet-front

About

Very simple tool to keep track of the papers you read.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages