Skip to content

Website for readers/writers community allowing book reviews (OC student project)

Notifications You must be signed in to change notification settings

nanakin/Django-book-review-OC

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LITReview Front-End and Back-end Project using Django

Preamble

This website was designed for a school project with specific requirements and fixed constraints. It was developed in a limited period of time and in this context this project is not intended to evolve that much once finished. This project is not open to contribution. The following need is fictive.

About the project

LITRevu logo

Project context

I recently joined a young start-up named LITRevu (referring to literature reviews) as Python Lead Developer. The start-up goal is to develop (and commercialize) a web based product allowing a community of readers and writers to publish and request reviews of books (or articles).

About the website functionalities

The web application allows to:

  • consult reviews and tickets (request for reviews),
  • post tickets (+ edit and delete),
  • post reviews (+ edit and delete),
  • follow authors/reviewers (+ unfollow),
  • signup (+ login and logout).

About the application technology, design and compliance

The application:

  • is using Django (open-source python-based web framework that follows the Model–Template–Views architecture)
  • is not using Javascript,
  • is not using CSS framework,
  • is valid W3C HTML and W3C CSS,
  • is compatible with small screens,
  • is following WCAG (Web Content Accessibility Guidelines)

The python code:

  • is following Django's best practices,
  • is PEP8 compliant (flake8 valid),
  • is Black formatted.

Screenshots

main edit-review abonnements

Technology

python-django

This application was tested with python 3.11 version, with pip 23.2, and django 4.2. The development environment was macOS 13.4 and firefox 115.

Installation

  1. Clone this repository:
    git clone https://github.com/nanakin/OC-P9-Django.git django-project
  2. Move to the project directory:
    cd django-project
  3. Create a virtual environment (optional):
    python3 -m venv venv
    and activate it:
    .\venv\Scripts\activate  # windows
    source venv/bin/activate  # unix and macOS
  4. Install project dependencies:
    pip install -r requirements.txt
  5. Move inside the django project:
    cd lit_review
  6. Create migration files (corresponding to database structure):
    python3 manage.py makemigrations
  7. Launch the server:
    python3 manage.py runserver
  8. Open http://127.0.0.1:8000/ on your web browser.

Use existing user

You can login with a pre-existing superuser Jangolito with password Djan-g0!.

About

Website for readers/writers community allowing book reviews (OC student project)

Topics

Resources

Stars

Watchers

Forks