From 5f3939af609deab268f298ab7abd92e2de608c6f Mon Sep 17 00:00:00 2001 From: Pekka Helenius Date: Sat, 3 Oct 2020 15:35:12 +0300 Subject: [PATCH] Update README: add images, update content layout --- README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 49 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 68e0b3a..1bb213b 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,6 @@ # Java Bookstore Project -![](sample_0.png) - -_Front-end view_ - -![](db_plans/sample_1.png) - -_[Database structure](db_plans/bookstore-model.mwb)_ +## Introduction - This repository contains school-related Java server-side project work for an imaginary book store with required/necessary back-end features & course requirement description. @@ -16,14 +10,57 @@ _[Database structure](db_plans/bookstore-model.mwb)_ - This repository, although it contains references to my website domain (`com.fjordtek`), is not in production use in my [public server environment](https://fjordtek.com). +## Overview + +### Front page + +![](images/page_home.png) + +_Front-end home page view with user sign-in form._ + +------------------------------ + +### Normal user view + +![](images/page_user_front.png) + +_Normal user view for the bookstore: get basic information of published books._ + +------------------------------ + +### Sales manager view + +![](images/page_salesmanager_front.png) + +_Sales manager view for the bookstore: view, edit and add books. Get published and unpublished books._ + +------------------------------ + +### Administration view + +![](images/page_admin_front.png) + +_Administration view for the bookstore: view, edit, delete and add books. Get published and unpublished books. Access REST API._ + +------------------------------ + +### Database structure + +![](images/db_structure.png) + +_[Bookstore database structure](db_plans/bookstore-model.mwb)_ + +------------------------------ + ## Repository structure -| **Type** | **Name** | **Description** | -|----------|-------------------------|-----------------------------| -| `Folder` | [bookstore](bookstore) | Main project folder (Maven) | -| `Folder` | [packaging](packaging) | OS-specific build scripts | -| `Folder` | [db_plans](db_plans) | SQL Database plans & drafts | +| **Type** | **Name** | **Description** | +|----------|-------------------------|------------------------------| +| `Folder` | [bookstore](bookstore) | Main project folder (Maven) | +| `Folder` | [packaging](packaging) | OS-specific build scripts | +| `Folder` | [db_plans](db_plans) | SQL Database plans & drafts | +| `Folder` | [images](images) | Various screenshots & images | ### Recommendations