Book Management and Commenting System - Disaster Research Unit Bibliography

Objective

This essential project enables end-users to create, read, update, and delete entries for book titles on specific topics, thereby establishing a unique database. The "review" option is essential, allowing readers to engage in discussions and share their thoughts.

Users Benefits and Goals

• Product Owner the website establishes a powerful tool for knowledge dissemination, networking activities, sharing and acquiring cutting-edge ideas on specific topics

• Final Users can expect several benefits from using this digital product

A) For the first-time user

• dynamic digital platform to contribute to and navigate through the content of book entries

For returning and frequent users

• a reliable source of the latest literature on the specific topic, a place to communicate with colleagues, learn what the scientific community members think on particular issues, or even their books that became part of this project.

User Experience (UX) Section

Main Features and Structure

Home Page

• The landing area offers an overview of the six books: title, author, time of entry creation, contributors' identity, and a summary.

• About page is divided into three sections:

• a: short textual explanation about the purpose of the project. This section contains the link to the Home page to make the navigation easier.

• b: The form section allows users to enter and submit bibliographical units in the database. Further development: The "Read" and"Update" buttons will be deleted. The "Delete" button will become functional. Superuser and the author of the entry will be able to delete db-elements, which should cause the deletion of all reviews related to this specific entry. The "Comment" button will be renamed the "Review" button, becoming a direct link to the review section.

• c: Capture featuring a forest fire—Further development: The Contact form, similar to one presented in "I Think Therefore I Blog," will be introduced instead of the existing capture to enhance cooperation with the product owner and allow minor corrections of book entries. More attention will be paid to the style of this page.

Additional Features

Navigation

• Home page 1: by clicking on DRU Bibliography in navbar 2: Home link in navbar 3:  - List of book navigation - Next and Prev button introduced Next Only; Prev Next; Prev Only;
  • Contribute 1: by clicking on the Contribute button on the Home page (in the further stages of development, the Contribute link will be added to the navbar)
  • Comment section by clicking on the words Comment Section on Home page
  • About page 1: About link in navbar 2: Contribute button in Home page

Authentification

All required functions have been incorporated. They are functional and styled, when possible, to improve the UX: Register_Log In; Log In; Loged In; Sign Up; Sign Out; No_Log_No_Review;

Displaying Static and User-Generated Images

• please check the detail view "At Risk: Natural Hazards, People's Vulnerability and Disasters" on the Home page: User-Generated Images;

Design and Development

Prehistory

• This is a continuation of a similar project whose development was interrupted due to family circumstances.
  Book Management and Commenting System. At its core are these wireframes:

Landing Page

CRUD Page

Model Design and ERD

Bibliography Model

• initial stage ERD Bibliography
• final stage ERD Bibliography

Review Model

• initial stage ERD Review
• final stage ERD Review

CRUD Functionality

• Create - submitting new bibliographical units
• Read - The user can see not only the list of books but each book
• Update - The user can update individual reviews. For this and Delete points, the explanation is attached:
  Delete and Edit Bugs 1; Delete and Edit Bugs 2;
  Delete and Edit Bugs 3;
• Delete - The user can delete individual reviews. Delete confirmation modal is operational: Delete confirmation modal

Technologies Used

• Frontend: HTML, CSS, JS, Bootstrap
• Backend: Python, Django, SQL

Software Used

• Multi-mockup-generator to create the mockup for responsive pages.

External Code Source

• navbar in base.html, inspiration from: Shaun (Net Ninja)

• responsive design in index.html and about.html, inspiration from: Shaun (Net Ninja)

• footer in base.html, adapted and slightly changed from: Code Institute

Learning Resources Used

• GeeksforGeeks
• StackOverflow

list of used book reviews:

• https://www.preventionweb.net/files/670_72351.pdf
• https://www.researchgate.net/publication/227704544_Climate_change_and_the_imagination
• https://academic.oup.com/book/40836
• https://nap.nationalacademies.org/catalog/13457/disaster-resilience-a-national-imperative
• https://www.amazon.de/-/en/David-Alexander/dp/1857280938
• https://www.routledge.com/Natural-Disasters/Alexander/p/book/9781857280944
• https://www.amazon.com/Disaster-Research-Multidisciplinary-International-Perspectives/dp/1138051616
• https://https://www.sciencedirect.com/science/article/pii/S2590061724000279
• https://www.amazon.de/-/en/Dr-Allen-Beattie/dp/B0CLH4J3SZ
• https://books.google.de/books/about/El_Ni%C3%B1o_Ready_Nations_and_Disaster_Risk.html?id=O1piEAAAQBAJ&source=kp_book_description&redir_esc=y

Deployment

• ElephantSQL to store database
• Cloudinary to store images

Testing

• review submitted testing; review submitted testing success; explanation: extra code added to target the precise success message. The captures show the initial and end stages of development.
• book submitted testing success;

Validation

Manual

• CSS CSS Index; CSS About; CSS Single View;
• HTML Index; About; Single View; Registration; Create Review;
• JavaScript JSLint doesn't support all ESJ feat; hence minor error reports Jslint. When possible, the raised issues addressed - too long text in the comments;
• Python Pythonium

Automatic

• conducted in a few cases

Accessibility

• testing black/red webaim.org
• testing white/red webaim.org

Bugs

• Favicon not visible in Firefox: [06/Aug/2024 08:31:59] "GET /4/ HTTP/1.1" 500 352382 Not Found: /favicon.ico. Visible in Edge and Chrome.
• deleted bibliographic unit still visible in the list Not Deleted;
• Server Error 500 when attempting to open single book view Server Error 500; The possible cause of the problem was detected. Still, the issue was left unaddressed due to the time scarcity. This problem appeared only a few days before the submission: stackoverflow
• Please, see the CRUD Functionality section of this document.

Further improvement

• use slugs (book's keywords) instead of the object's id to improve the site's ranking in search engines.

Acknowledgments

• Capture origin Flickr Account of Christine Warner-Morin
• "Orange Fire logo" origin Freepik.com

• super helpful members of the Student Support Team. Roman, Rebecca, Sarah, Thomas, Oisin and Alan, thank you!