atheneum

command module
v0.0.0-...-f21bc9d Latest Latest
Warning

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

Go to latest
Published: Jul 18, 2019 License: MIT Imports: 10 Imported by: 0

README

Atheneum

Go Report Card Docker Pulls PRs Welcome

Atheneum is a simple CRUD API written in Go to manage personal collections of books. Easy to use, configure and extend.

Why

I read a lot. It's one of my favorite things to do. And that's why for me it's important to have a place to organize the books I've already read or I want to read.

At first I tried with existing platforms. But some of them just seemed abandoned or I just didn't like them. Without options, I finally decided to create my own system. Atheneum.

How it works

Atheneum creates a BoltDB database if it does not exist in which you can add books, authors and sagas that you can manage in a quick and easy way through an API.

ToDo

  • Context.
  • Use Postgres instead of BoltDB.
  • Better CLI.
  • Web interface.

Installation

Docker Image
docker image pull danielkvist/atheneum
Go Get
go get github.com/danielkvist/atheneum

# Or

go install github.com/danielkvist/atheneum

Flags

-address string
    TCP address to listen on for requests (default "localhost:9090")
-database string
    where the database is supposed to be or should be (default "./data/library.db")
-password string
    password for basic authentication (leave empty for no authentication)
-username string
    username for basic authentication (leave empty for no authentication)

Usage

Docker Container
docker container run --name atheneum -v /data:/data:rw -p 9090:9090 danielkvist/atheneum
CLI
atheneum -address=":8080" -username="myusername" -password="bookworm"

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package db exports multiple utilities to work with BoltDB databases.
Package db exports multiple utilities to work with BoltDB databases.
Package handler provides endpoints for a simple CRUD API.
Package handler provides endpoints for a simple CRUD API.
Package model exports a series of schemes for books, authors and sagas.
Package model exports a series of schemes for books, authors and sagas.
Package server provides simple utilities to create new http.Server.
Package server provides simple utilities to create new http.Server.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL