/vbooks

Primary LanguageGoBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

vbooks

This is the backend server for the vbooks project - a place for small communities to share PDFs, ePubs, and other reading resources with each other.

Resources

Planning, feature requests, and bugs live at our issue tracker.

Send patches and questions to ~izzy/vbooks-dev@lists.sr.ht. When sending patches, lease use --subject-prefix PATCH backend for clarity.

Backend

Building

Dependencies:

  • go (>=1.12)

    cd $REPO/cmd/vbooks-server && go build

Because the vbooks project is using go modules, the repository should be checked out in a location outside of GOPATH or compiled with GO111MODULE=on.

Live Reloading for Development

Live reload of the server while editing code can be accomplished with codegangsta/gin by running

gin --build cmd/vbooks-server --excludeDir client

in the root of the repository.

Frontend

The frontend code lives in client/

Dependencies:

  • npm

Run npm install to get all the dependencies.

To run the development frontend, run npm run dev from the client directory.