Browse Source

Update README: add images, update content layout

v0.0.3-alpha
Pekka Helenius 4 years ago
parent
commit
5f3939af60
1 changed files with 49 additions and 12 deletions
  1. +49
    -12
      README.md

+ 49
- 12
README.md View File

@ -1,12 +1,6 @@
# Java Bookstore Project # 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. - 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). - 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 ## 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 ### Recommendations


Loading…
Cancel
Save