Coder Social home page Coder Social logo

anthology's Introduction

Anthology

An easier way to keep track of the books on your office bookshelf.

  • Uses Google authentication
  • Keeps track of multiple copies of each book
  • Looks up book details from Google Books and Openlibrary based on the ISBN

Getting started

bundle install
bundle exec puma -p 5000

If you're in the development or test environments, OmniAuth's developer strategy is available, and selected by default. This allows you to authenticate without using Google by providing details for a stub user. If configuration for Google is present, Anthology will default to using authentication with Google instead.

Configuration

The app is configured with a collection of environment variables:

  • LIBRARY_TITLE - (optional) name of the library, displayed throughout the app. This will default to "Library" if this is not set.
  • GOOGLE_CLIENT_ID
  • GOOGLE_CLIENT_SECRET
  • RAILS_SECRET_TOKEN
  • PERMITTED_EMAIL_HOSTNAMES - the hostname(s) that are allowed to log in to the app
  • DB_USERNAME - (optional) Defaults to "books" if this is not set.
  • DB_PASSWORD - (optional)
  • DB_HOST - (optional)
  • DB_PORT - (optional)

Setting up the Google Client ID and Google Client Secret

To set up the Google authentication, you will need to get a GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET by visiting the Google API console and choosing the option to create an "OAuth Client ID". You should select 'Web application' as the application type and enter <site-address>/auth/google/callback as the "authorised redirect URI". No additional OAuth 2.0 scopes need to be added.

CI setup

CI runs using GitHub Actions

Licence

Anthology is released under the MIT Licence.

anthology's People

Contributors

dependabot[bot] avatar heathd avatar issyl0 avatar jabley avatar jordanhatch avatar klssmith avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  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.