Git Product home page Git Product logo

bookshelf's Introduction

Bookshelf

Bookshelf is a tiny web app made to manage your collection of readings. Since I usually read series of book is usually create one Book per serie. When creating your book you can also upload a file to it, for me it's the zip file containing all serie's ebooks.

Books data include:

  • a title
  • an author
  • a comment
  • a note
  • a file to store ebook file
  • a reading state (still reading or finished)
  • a completion state (still begin written or finished)

You can search by author or title in realtime with liveview.

Technical details

Bookshelf is written in Elixir using Phoenix. Your bookshelf is protect behind a simple HTTP authentication (USERNAME and PASSWORD environment variable are used, defaulting to user / password) To keep things simple uploaded file are simply written directly into the database.

Development

To start your Phoenix server:

  • Setup a .env.dev file containing databse configuration variables: DB_USERNAME, DB_PASSWORD, DB_HOST
  • Source your env file
  • Install dependencies with mix deps.get
  • Create and migrate your database with mix ecto.setup
  • Start Phoenix endpoint with mix phx.server or inside IEx with iex -S mix phx.server

Now you can visit localhost:4000 from your browser.

bookshelf's People

Contributors

hfabre avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.