Alma Acquisitions - Open Source

Display your library's latest acquisitions using data coming from Alma.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Alma Acquisitions - Open Source (AAOS) is the open-source version of Acquisitions - New books at the library in use at Leiden University Libraries.

AAOS was created to display the latest acquisitions made at Leiden University Libraries: e-books, journals, e-journals, etc. It was designed to allow the library's employees to manage the acquisitions lists via an clear and user-friendly admin interface, rather than depending on the actions of a developer to create or modify them.

Features

• An admin panel for creating, updating, and deleting displayable acquisitions lists
• An easy-to-customize environment
• Responsive front-end

Built With

• 
• 

Getting Started

Please refer to the documentation for more information about creating a test user, setting up the database, etc.

In general: built with Laravel 8, AAOS follows the same installation steps of any application built using this framework. Make sure you have PHP >v.7.3.33, you have created a MySQL database, and off you go!

Prerequisites

AAOS has few requirements:

• PHP V.7.3.33 and above
• Composer
• MySQL
• An Analytics - Production Read-only API key from the ExLibris Developer Network, coming from an account bound to your institution.

Installation

1. Download the latest release package
2. Unzip the release package to a folder of your choosing
3. composer install to install the required dependencies
4. Copy the .env.example file and rename it .env
5. Edit the .env file with your details and the name of your MySQL database
6. Use the command php artisan migrate:fresh --seed to populate the database with some sample data, and a user account for experimenting
7. php artisan serve to see your local copy of Alma Acquisitions - Open Source in action.

Usage

AAOS displays data coming from Alma Analytics. If you want to change the data that is displayed in AAOS, you must edit your queries in Alma Analytics.

For example: If your institution wants only to display physical books, you will have to edit the relative saved query in Alma Analytics. Similarly, if you would prefer to display only electronic books, you will have to remove the physical books from the query.

For detailed instructions on how to create Alma Analytics queries that can be used by Alma Acquisitions - Open Source, please refer to the documentation.

Roadmap

Leiden University is busy with the following developments on its own version of this application. Once ready and tested, they will be shared with this repository:

• Google Books covers
• Frontend redesign

See the open issues for a full list of proposed features and known issues.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GNU General Public License v3.0 License. See LICENSE for more information.

Contact

Leiden University Libraries - Contact us

Twitter: @ubleiden

Project Link: https://github.com/LeidenUniversityLibrary/Alma-Acquisitions-Open-Source

Acknowledgments

• Stack Overflow
• Bootstrap
• Laravel
• Alma - Ex Libris user community discussion list for Alma