🔎 OBA Obachine @ obachine.rijks.website 🔍

Obachine

With Obachine you can build your own search engine to search for books in the Amsterdam Public Library

📖 Introduction

Obachine is a search engine made for the Amsterdam Public Library (OBA) and is mainly built for their younger age demographic. The purpose of this application is to educate them on the inner workings of a search engine where the outcome is based on the given inputs. However, it's also developed to enhance the quest of finding a book to read; making it easier and enjoyable.

It works by literally building the search query with using the machine blocks which are acting as search filters (i.e. author, genre).

To view a full in-depth report of this project you can view the GitBook of this project.

Please note: the whole UI is in Dutch 🇳🇱

⚙️ Installation & Development

Tech Stack

• HTML, CSS & JS
• Node.JS w/
  • Express webserver
• Webpack automation
• Node OBA API
• BoekenLiefde API

Prerequisites

• Make sure you have node installed on your machine.

Installation

1. Clone this repo

$ https://github.com/rijkvanzanten/obachine.git

2. Run npm install to install all dependencies.

You will need a .env file in the root of your project which contains a public/secret keypair for the OBA API and BoekenLiefde API:

PUBLIC=1234567890
SECRET=1234567890
BL_URL=https://apiurl
BL_KEY=1234567890

Usage

• To use the app in development mode, use npm start
• To build the application use npm run build
• To test your JS use npm run lint:js
• To test your CSS use npm run lint:style

The last two commands are running within Webpack, but they are there if you want to use them besides Webpack.

✅ Todo's / ✨ Wishlist

To see all upcoming todo's and features please navigate to the issues page of this repo.

• Add animations for a richer experience
• Add gamification for a better user experience
• Add swiping mechanism for filters
• Add "read more" button for longer reviews and always display short ones
• Re-design machines to be more clear on their function
• Enhance usability by cross-browser testing
• Add help screen with a bit of info on the application
• Add start/end tunnel animations

📄 Contributing

Please read Contributing for details on how to contribute to this project. To see a list of everybody who participated go to the Contributors page.

When you do, please also view the Code of Conduct for this project.

Core Team

Rijk van Zanten	Giulia Meerman	Danny de Vries	Mirza van Meerwijk	Pierre Bleeker

📃 License

This project is licensed under the MIT License