The Bookshelf by Flying Saucers

Video Demo Here!

Roster / Roles:

• Emory Walsh - Project Manager
  • Make changes to design doc
  • Help with front end design
• Lauren Pehlivanian - Back End
  • Back end
  • Creating accounts and ability to create bookshelfs
  • Book reccomendation engine
• Kiran Vuksanaj - Back End
  • Designing databases
  • Google login
  • Neo4j to create 'others who liked this chose ...' if time allows
• Sophie Nichol - Front End
  • Front end design
  • Using Bootstrap

Website Description:

The Bookshelf is your one stop shop for finding new books to read and seeing what others are reading. To find yourself a new book to read, head on over to the 'Bookfinder'. Here, you can select a genre, a minimum length, and a maximum length for the book you want. Press submit and a whole list of books will come up. To see more information on any of these books, just click on the cover! You can also create bookshelves for yourself. Your bookshelves can be themed, they can show the books you read during a certain time period, or anything else you want! To create a bookshelf, go to 'My Bookshelves' and click the 'Create a bookshelf' button. There are two ways to add books to your bookshelves. First, in 'My Bookshelves', you can select the bookshelf you want to add to and use the add book form. Second, you can use 'Bookfinder', and when you click into a book, use the 'Add to Bookshelf' button.

Launch Code:

Download Book Data

Download CSV dataset from Kaggle Dataset - Goodreads Best Books

• You only need the book_data.csv file, not the images.
• Download the file to <repo>/app/dat/book_data.csv

Cloning

First, procure the ability to run Git commands.

• On Windows: Install Git Bash.

• On macOS: Use the git-osx-installer. If you have XCode installed on your machine, you may already have Git functionality.

• On Linux (preferably an Ubuntu based distribution): You already have Git!

Now, you can clone this repo. To do so, type into a terminal session:

git clone https://github.com/EmoryWalsh/softdevFinal.git

The project repo should then clone into whatever folder you ran the clone command in.

Dependencies

You must install the pip modules listed in the /doc/requirements.txt file. To do so, install them in a Terminal with:

pip3 install -r <location of requirements.txt file>

The -r flag is necessary to distinguish it from a typical pip install. Without the -r, pip will look for a package online called "requirements.txt". That is obviously not desirable.

Note that on certain systems (like the school computers), the pip command may be restricted. To get around this, create a virtual environment with:

python3 -m venv <name_of_venv>

Note that if your system only has Python 3 installed, just remove the 3 from the above command.

To activate the virtual environment, cd into the directory you created the environment in, and run the "activate" file. Now, you should be able to pip install the requirements. To deactivate the environment, run the "deactivate" file.

Run the program

After installing the required dependencies, all you need to do to run the program is to type into a terminal session:

cd app
python3 __init__.py

Again, remove the 3 after the "python" if necessary.