IBDB

Overview:

Full stack web application that allows users to browse, search and save books to their personal library.

Table of Contents🐛

• Tech Stack
• Setup/Installation
• To-Do

Tech Stack

Frontend: HTML5, CSS, Javascript, jQuery, Bootstrap
Backend: Python, Flask, PostgreSQL, SQLAlchemy
APIs: GoogleBooks, Open Library

Setup/Installation ⌨️

Requirements:

• PostgreSQL
• Python 3.6
• Google Books and Open Library API keys
• Open library dump datasets of authors and editions

To have this app running on your local computer, please follow the below steps:

Clone repository:

$ git clone https://github.com/alishalopes87/IBDb.git

Create a virtual environment🔮:

$ virtualenv env

Activate the virtual environment:

$ source env/bin/activate

Install dependencies🔗:

$ pip install -r requirements.txt

Download Open Library dump datasets Authors and Editions Open Library. And get your own secret keys🔑 for Google Books Save them to a file secrets.py. Your file should look something like this:

APP_KEY = 'xyz'
GOOGLEBOOK_API_KEY = 'abc'
GOOGLEBOOK_API_SECRET = 'abc'

Create database 'Library'.

$ createdb Library

Create your database tables and seed🌱 example data.

$ python model.py

Run the app from the command line.

$ python server.py

If you want to use SQLAlchemy to query the database, run in interactive mode

$ python -i model.py

TODO✨

• Add migrations for search engine
• Add more testing!
• Add rating system for books