kevinbowen777 / bookstore

An online bookstore created with the Django web framework

Bookstore

• A basic bookstore application built using the Django 5.0.x web framework

Table of Contents

• Features
• Installation
• Testing
• Application Demo
• Screenshots
• Reporting Bugs

---

Features

• Application

  • Add book reviews
  • Upload book covers
  • Basic search capability
  • User registration with email verification & social(GitHub) login using django-allauth
  • Bootstrap4 & crispy-forms decorations
  • Customizable user profile pages with bio, profile pic, & country flags
  • For additional links to package resources used in this repository, see the Package Index

• Dev/testing

  • Basic module testing templates
  • Coverage reports on web
  • Debug-toolbar available. See notes in config/settings.py for enabling.
  • Examples of using Factories & pytest fixtures in account app testing
  • shell_plus with IPython via django-extensions package
  • Nox testing sessions for latest Python 3.10, 3.11, and 3.12
    • Coverage (nox -s coverage)
    • Sphinx documentaion generation (nox -s lint)
    • linting (nox -s lint)
      • ruff
      • djlint
    • safety(python package vulnerability testing) (nox -s safety)
    • pytest sessions with pytest-cov & pytest-django (coverage run -m pytest)

• run command menu

  (adapted from Nick Janetakis' helpful docker-django-example)

  You can run ./run to get a list of commands and each command has documentation in the run file itself. This comes in handy to run various Docker commands because sometimes these commands can be a bit long to type.

  If you get tired of typing ./run you can always create a shell alias with alias run=./run in your ~/.bash_aliases or equivalent file. Then you'll be able to run run instead of ./run.

---

Installation

• git clone https://github.com/kevinbowen777/bookstore.git
• cd bookstore
• Local installation:
  • poetry shell
  • poetry install
  • python manage.py migrate
  • python manage.py createsuperuser
  • python manage.py runserver
• Docker installation:
  • docker compose up --build
  • docker compose exec web python manage.py migrate
  • docker compose exec web python manage.py createsuperuser Additional commands:
    • docker compose exec web python manage.py shell_plus (loads Django shell autoloading project models & classes)
    • docker run -it django-start-web bash (CLI access to container)
• Browse to http://127.0.0.1:8000 or http://127.0.0.1:8000/resources/
• Pre-commit:
  • To add the hook, run the following command in the poetry shell:
    • pre-commit install

---

Testing

• docker-compose exec web python manage.py test
• coverage run -m pytest
• Nox (includes sessions for black, Sphinx documentation, lint, safety, tests)
  • testing supported for Python 3.10, 3.11, 3.12
  • e.g. nox, nox -rs lint-3.11, nox -s tests
    • nox
    • nox -s black-3.12
    • nox -s docs-3.11
    • nox -rs lint-3.10 (Use the 'r' flag to reuse existing session)
    • nox -s safety (will run tests against all Python versions)
    • nox -s tests

---

Application Demo

A live application demonstration:

• TBD

---

Screenshots

Home

Search Results

Book detail with reviews

Book detail with django-debug-toolbar

---

Reporting Bugs

Visit the Issues page to view currently open bug reports or open a new issue.

bookstore's Issues

Remove bullets from book_list template

Cover not uploading on save

This issue is resolved by adding the enctype to the form. For example:

<form enctype="multipart/form-data" method="post" action=".">
  {% csrf_token %}
  {{ form.as_p }}
  <button type="submit" class="btn btn-primary">{{ action }}</button>
</form>

See also: https://stackoverflow.com/questions/1718429/file-does-not-upload-from-web-form-in-django

Link BookAdd form to Book list

Upgrade to Django 4.0.6

Upgrade to Safety v2.0.0

Reduce width of login & signup fields

Currently, the width of login and signup fields spans most of the width of the page.

We can reduce the width using the class parameter in the form. For example:

<form class="col-md-6" method="post">                                         
  {% csrf_token %}                                                            
  {{ form|crispy }}                                                           
  <button class="btn btn-success" type="submit">Log In</button>               
</form> 

See Example: Stacked-to-horizontal section here: https://getbootstrap.com/docs/3.4/css/#grid-example-basic

Upgrade to Safety v2.0.0

duplicate of #49 close

Create user profile with bio, pic & country

Break tests into separate model, form, view modules

Set up Nox for 3.11 testing

Add favicon.ico

Move flake8 configs to .flake8 file

Update README install instructions

Add favicon.ico

Improve book list

Remove bullets from list. Perhaps use the following css:

ul.no-bullets {
  list-style-type: none; /* Remove bullets */
  /* padding: 0;  Remove padding */
  margin: 0; /* Remove margins */
}

Add ReviewUpdateView

Setup Sphinx documentation

Re-name Heroku project & redeploy to new URL

Add pagination to book list

Override allauth email & password templates

Create new template to match our theme and override the default django-allauth templates for the following:

templates/account/email.html
templates/account/email_confirm.html
templates/account/password_change.html
templates/account/password_reset.html
templates/account/password_reset_done.html
templates/account/password_reset_from_key.html
templates/account/password_reset_from_key_done.html

Update base.css template

Using the base.css as a template, improve the text formatting.

Create BookUpdateView

Link BookUpdate form to Book detail view

Move Review functionality to userspace

Currently, adding a review is only possible through the admin interface.
Create a view that will allow users(with appropriate permissions) to Create,
Update, & Delete reviews from the main app pages.

Add pyenv version for 3.8, 3.9 testing

Move pre-commit dependencies to Poetry

Reconfigure Dockerfile to use Poetry

Update project issue labels

Verify settings for whitenoise

Application is missing the STATICFILES_STORAGE parameter. Whitenoise needs to
be moved from STATICFILE_FINDERS to the STORAGE variable.

Add image carousel to home page

Rename _base.html

Rename the file templates/_base.html to base.html to match the rest of our projects. Update all project files that call this template. I.e. change {% extends '_base.html' %} to {% extends 'base.html' %}

Add div container to pages

The content of pages needs a slight adjustment to bring the header away from
the navbar. Add the following:

<div class="container">
  <p>
  ...
  </p>
</div>

Handling media images in Heroku

According to this
bug Heroku
does not allow for the handling of uploaded media files. You may need to look
at something like django-storage to serve from a 3rd party resource.

We are in the process of migrating off of Heroku. This won't be addressed.

Create BookAddView

Resolved in commit 3002a33

Install pytest & coverage

Update pre-commit yaml with new exclusions

Add friendly name to containers

Update flake8 & black line-length limits

pytest-cov not showing missing

Add forgot password link in dropdown

Add ReviewDeleteView

Create initial functional test template

Install shell_plus

requirements.txt points to local cache

Use pip list --format=freeze > requirements.txt to fix.

Create BookAdd form

Add env template

add an image of a library to the home page

Preferably from the 19th century. Use rounded corners

Create BookFactory for BookView testing

Add dropdown toggle menu in navbar

Update the navbar and move the logout & about links under a dropdown toggle. In addition, create links for 'change password(account_set_password)' and 'change email(account_email)'

Add nox for testing

Resolved with #d1b23f9