Skip to content

WeDism/SpringPetSpace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status codecov

This is a social network for pets. It may be tested here: SpringPetSpace

Table of contents

  1. How to run app
  2. Tested systems
  3. Tested browsers
  4. Tutorial
    1. Intro
      1. Use Case diagram
      2. Logical DB Schema
      3. Physical DB Schema
    2. How to use Pet Space
      1. Sign Up and Sign In
      2. USER role
        1. USER role intro
        2. How to add pet
        3. How to find people and send them friend requests
        4. How to approve your friend request
        5. How to write a message to your friend
        6. How to mark a message as read
        7. How to view another profile
      3. ADMIN role
        1. ADMIN role intro
        2. How to add pet
        3. How to find people and send them friend requests
        4. How to approve your friend request
        5. How to write a message to your friend
        6. How to mark a message as read
        7. How to view another profile
        8. How to add new species
      4. ROOT role
        1. ROOT role intro
        2. How to view another profile
        3. How to add new species
        4. How to delete user
        5. How to change user role
        6. How to add new species

The following steps are required for running the application

  1. Download and install java 9
  2. Download and install postgres 10
  3. Download and install tomcat 8.5
  4. Download latest war file from releases
  5. Deploy SpringPetSpace-1.0.war by tomcat 8.5
  6. cd $YOUR_PATH\apache-tomcat-8.5.24\webapps\CRUDPetSpace-1.0\WEB-INF\classes
  7. Find schema.sql
  8. Uncomment CREATE DATABASE pet_space; in schema.sql file and run sql script
  9. Find data.sql and run sql script

Tested systems

  1. Windows 8
  2. Heroku (PaaS)

Tested browsers

  1. Google chrome desktop 64 version and above
  2. Google chrome mobile 64 version and above

Tutorial

Intro to design

Use Case diagram

This is social network service SNS. This system contains three type of user essences: USER, ADMIN and ROOT. These essences extends is an abstract essence. The ROOT essence is main and most credential user. This essence may be management other essences. The USER is a most popular essences because it's contains main functions such as find friends and adding friend, send messages few friends each shipment new message, follow and unfollow pets. The ADMIN essence extend the USER and adds a ${Add species} function. See all use cases at the next diagram.

Diagram of Use Case the social network

Logical DB schema

DB schema build of using IDEF1X data modeling language. This logical db scheme was develop with restrictions which helps implements integrity of the database. See the details in the following scheme.

Logical DB Schema

Physical DB schema

In this project was tested postgres DBMS physical schema in the following image you can see physical diagram.

Physical DB Schema

This physical db scheme was develop with restrictions which helps implements integrity of the database.

How to use Pet Space

Sign Up and Sign In

Go to Pet Space. You are see next image.

Sign In

Click to ${Sign Up} button. Fill registration data. You can see example in the next image. If you enter verified data. You should be see green notification about completed action. Then click on ${Sign In} left button and enter your nickname and email. After success registration you have to enter your sign up data and click ${Sign In} button. As a result you will sign in Pet Space system.

Success Sign In

USER Role

USER role intro

User role is a base role. The role can use main system capabilities. All capabilities see in Use Case diagram.

Sign in Pet Space as user essence. After success authentication you should be see the next image. Your role should be USER.

Sign in as user

How to add pet

To adds your pet click on the ${Add pet} button and fill data. Click on the ${Submit} button. If you enter valid data you should be see green ${Pet added} message in the left bottom part. If you back to home page you can see your pet in a ${Your pets} table of the bottom part your page.

Add your pet

How to find people and send them friend requests

To request to friend click on the ${Find friend} button. After open new page fill data as the next image.

Filled data of find friend

If your data was valid you have to see another account. Click on ${Request} checkbox under ${Add friend request} column. Next you should be see success notification of the top right corner as the next image.

Complete friend request

If you back to home page you can see your request of friend in a ${Your friends} table ahead of the your ${Your pets} table on your page as the next image.

Requested friend of your account

How to approve your friend request

Requested account have to change in drop-down list state REQUSTED to APPOVED in the table name ${Your friends} and column name ${Friend state} on the home page. You can see as the next image.

Change drop-down list

How to write a message to your friend

After success request your friend you have to see changed state REQUSTED to APPOVED as ahead chapter. You should be see next presentation.

APPROVED state friend request

To send message your friend click ${Messages} link. After change location from ${Home} page to ${Messages} page choose one or a lot of accounts and write new message. If you do preview steps you should be see success message in the top right corner. These steps are present in the next presentation.

Send message my friend

After success send your message your should me see next notification on the right bottom corner. Your message notification you can see the next image.

Message notification about your message

How to mark a message as read

After get your new message you can mark as read new message with two ways: First way click ${✓} on the message notification. See as the next presentations.

First way mark as read

Second way click ${Messages} on the top page and all messages will be marked as read.

Second way mark as read

How to view another profile

View another profile

ADMIN Role

ADMIN role intro

Admin role extends user. The admin difference of user only one option. The option is adds new pet species. Other capabilities see in Use Case diagram.

Sign in Pet Space as admin essence. After success authentication you should be see the next image. Your role should be ADMIN.

Sign in as admin

How to add new species

To add new genus pet you should be has ${ADMIN} role. Next go to ${Home} page and click on the ${Add genus pet} button. After redirect ${Add genus pet} page input new ${Genus pet} name and click on the ${Submit} button. After valid data you have to see success ${Genus pet added} message. New added genus you can see in the {Genus pet} table. If your genus pet is success added you and other users can use your genus pet name. See as the next presentation.

Add new genus pet

ROOT Role

ROOT role intro

Root role is a general role. The role can manage other roles such as user and admin. Other capabilities see in Use Case diagram.

Sign in Pet Space as root essence. After success authentication you should be see the next image. Your role should be ROOT.

Sign in as root

How to delete user

Sign in Pet Space and go to home page. Next search ${Actions} column and click needed button in row. After successful operation you saw green notification about completed action. See as the next presentation.

delete user from system

How to change user role

Sign in Pet Space and go to home page. Next search ${Role} column and choose needed option in few variants. After successful operation you saw green notification about completed action. See as the next presentation.

change role user

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •