This version of Shelfreader is out of date. There is a new repository with updated code at the link below:
ShelfReader is an open source web application developed by Corey Wetherington and Scott Wagner at Penn State University Libraries. This application is being used by nearly all of Penn State's libraries. The user interface presents a visual display of shelved items and indicates which books need to be moved and where they need to be moved in order to correct shelving mistakes. It also flags items that have item record metadata errors.
- You must have php installed on your computer.
- The php dependency manager Composer.
- A databse (MySQL, PostgreSQL, sqlite).
- To run the app in production rather than with the php development server as shown below, you would need Nginix or Apache.
ShelfReader was developed using Laravel, a php framework. As an alternative to installing prerequisites on the host computer, there are several options for running Laravel applications in docker containers such as Sail or Laradock.
Clone the code to a directory on your computer.
In the application root (the directory where the "app" folder is located):
-
Open a command prompt in that directory and type "composer install".
-
Rename the file named .env.example to .env, and insert the correct values for your database connection.
-
To create the database tables type "php artisan migrate".
-
Run "php artisan key:generate" to install an encryption key for your app.
-
Run the command "php artisan serve" to start the app in the php development server and go to the address shown in the output.
Thank you for considering contributing to ShelfReader! You can contact me at [email protected].
ShelfReader is open-sourced software licensed under the MIT license.