indiebookclub

indiebookclub is a simple app for tracking books you are reading https://indiebookclub.biz

Installation

indiebookclub requires PHP, MySQL, and Composer. It is intended to be installed at the root of a domain or sub-domain.

• Set the domain’s document root to the /public directory
• Configure the server to route requests through /public/index.php if they don’t match a file
  • If you are running Apache, do this by renaming /public/htaccess.txt to /.htaccess
• Set up MySQL tables using /schema/schema.sql
• Run composer install
• Rename /.env.example to /.env and fill in the hostname, base URL, and MySQL connection information

Environment Variables

In development, phpdotenv will load the .env file on each request to populate environment variables. In production, it is recommended to set the actual environment variables to avoid that overhead. Set the environment variable APP_ENV=production to prevent loading the .env file.

Maintenance Mode

Maintenance mode displays a maintenance message in place of all pages on the app. You can specify an IP address that is able to browse the site normally.

To enable maintenance mode, update /app/settings.php. Set offline to true and developer_ip to your IP address.

Development Mode

Development mode displays all error messages and restricts login to a single domain. Unlike maintenance mode, public pages remain visible and do not display a maintenance message.

To enable development mode, set the environment variable APP_ENV to dev (or anything other than production). Then update /app/settings.php and set developer_domain to the domain you want to enable logins for.

Credits

• Inspired by and using open source code from Aaron Parecki’s Teacup and Quill.
• “Book” icon by Beth Bolton from the Noun Project.
• Naming inspiration: Marty McGuire

License

Copyright 2018 by gRegor Morrill. Licensed under the MIT license https://opensource.org/licenses/MIT

This project also uses code with the following copyright and licenses:

• PhpIsbn library Copyright 2012 by Michael White. Licensed under the MIT license.
• Teacup Copyright 2014 by Aaron Parecki. Licensed under the Apache License, Version 2.0.