Skip to content
/ booklyst Public

A website that stores user's book information.

License

Notifications You must be signed in to change notification settings

dcsp3/booklyst

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 

Repository files navigation

image

Booklyst is a web app used to store a user's book information. The main webpage features a list of books entered by the user and information regarding them. Each book has it's own separate page which shows further details like 3 sentences and highlights of the book. It also features a "Read Later" webpage which can be used to list any book the user may want to read in the future. The web app uses Google Books API and it's database to retrieve information. This is a project made for personal use.

The website is hosted on PythonAnywhere and is live on https://dcsp3.pythonanywhere.com. Please note that it is not mobile compatible.

Features

My Books

This is the homepage of the website and displays all the books added by the user in a list. It shows the cover page, title, author, rating, date finished and genre for each book. It also has a remove button for each book which deletes it from the database.

read list

Read Later

This webpage displays all the books added to "Read Later" by the user. It displays the cover page, title, author and summary of the book. It also has a remove button for each book which deletes it from the database.

unread list

Individual Book Pages

Each book in "My Books" has a separate page (identified by the book id) which shows all information about the book from the homepage and the 3 sentences and highlights given by the user. It also has an edit button to make any changes to the information.

book

How It Works

Adding a book to "My Books"

my books add To add a book to the list of read books, the user has to click on the "Add Book" button at the bottom of the home webpage. This leads to a new page with a form. The user has to input the title, rating, date finished, 3 sentences (or 3 major learnings) and highlights from the book. On clicking submit, the title of the book is used as the search term for the Google Books API to retrieve the cover, title and author of the book. This is then saved in the database and displayed on the "My Books" webpage.

Adding a book to "Read Later"

read later add To add a book to the list of unread books, the user has to click on the "Add Book" button at the bottom of the read later webpage. This leads to a new page with a form that only has a 'title' field. On clicking submit, the title of the book is used as a search term for the Google Books API to retrieve the cover, title, author and the summary of the book. This is then saved in the database and displayed on the "Read Later" webpage.

Installation

Since django files are automatically generated and individual to each web app, a possible method to replicate this project is to create an app using the documentation and copy-pasting the python, html and css files.

Technologies Used

  1. Django: Web framework
  2. Google Books API: Retrieving book information

Attributions

About

A website that stores user's book information.

Resources

License

Stars

Watchers

Forks