Skip to content

Latest commit

 

History

History
90 lines (62 loc) · 2.92 KB

README.md

File metadata and controls

90 lines (62 loc) · 2.92 KB
Raw

snowy

snowy

Documents and contents repository

Badges

travis-ci Go Report Card

Introduction

Snowy is a append only ledger for document contents, that allow you to associate tags to a piece of content that can be queryable from the rest end point. The snowy application is split into two distinct parts, the ledger and the associated content for that ledger entry.

Modification of ledgers and contents is not possible, instead new entities are required to be inserted in an append only fashion, where a full revision and audit trail can be viewed for each ledger.

Setup

Local development

Snowy expects that you have a $GOPATH configured correctly with $GOPATH/bin in your path and that you've installed it using go get .... Once these are done, it should be as simple as make all, which will get all the correct dependencies for you to start working with the code.

Integration development

Integration development (testing) requires both docker and docker-compose to be installed, if testing against the remote filesystem (Amazon s3), then you'll need to set some environmental variables. There are two ways to do this:

  1. Export the env vars, so they can be read
  2. Put a .env file in the root of the snowy project with the following values filled in:
AWS_ID=
AWS_SECRET=
AWS_BUCKET=
AWS_REGION=
AWS_TOKEN=

Then it should be a case of running the following:

docker-compose up --build -d
make integration-tests

This will fetch an instance of postgresdb for you and setup all the right schema information, along with any other dependencies, before running the integration tests.

API Endpoints

The following contains the documentation for the API end points for Snowy.

Contents

Contents API is for retrieving files from the underlying storage. The API allows insertion and selection of files, it is not possible to update an image as all files are immutable, so new copies of the file are always stored in the storage.

Ledgers

Ledgers API is for retrieving the ledgers of all the contents found with in Snowy. Each new content is appended to a table, then added to the ledger so querying becomes possible. Modifying a ledger or content is not possible and to add new revision to the ledger a new ledger, content can be be appended using the same resource_id.

Journals

Journals API allows for inserting/appending both contents and ledgers in one request. The Journal API uses both the Contents and Ledgers repository API under the hood. In essence the Journals API is a thin wrapper over the underlying storage system in a composable manor.