PetClub report technical specifications

Description:

PetClub is a Web App designed to cover the needs for an online examination record repository for you pets!

A user can keep all of his pet's info in one place but also be able to keep up with his vet's examinations and perscriptions for his pet. In addition he can check out businesses close to him, or post an ad of a lost pet or one he just found.

PetClub is not only for simple users. Vets can also register their business by buying a subscription package which gives them the opportunity to advertise their business. Also it gives them the ability to keep an online record for their patients.

Other pet related businesses like pet shops, pet groomers etc can be advertised too using the PepClub.

Technical description:

Back-end framework:

Java Spring boot project: Spring JPA - Security - Google guava - JWT - Javax mail - Javax validation - Web socket

Front-end framework:

HTML5 - CSS - TypeScript - Angular 2

Database:

MySQL

External Libraries:

Here map - ngx-editor - ngx-paypal - ngx-awesome-popup

Requirements and how to run the application:

To run the application please make sure that you have installed the following:

Java 8 - node.js - MySQL

Steps:

Git clone the project from GitHub repository
Through the terminal, navigate to the Angular folder PetClub and type:
- npm install
- npm install ngx-editor
- npm install ngx-paypal -save
- npm i @costlydeveloper/ngx-awesome-popup
Create a Database with the name PetClub in your MySQL database
Open the application.yml (inside the src folder in Java)
- set Database name
- set Database username
- set Database password
Email Service: Open Java app inside of constant and
- change your username (email)
- and password
Get a Here map API key
- https://developer.here.com/tutorials/getting-here-credentials/
Open angular/PetClub/src/app/map/map.component.ts and write your here map API key in line 49
Run Java program

Java Roles

By registering to the PetClub web app the user has the role USER. By buying a subscription package he can take the role of ADVERTISED so he can advertise his business. And with the proffesional subscription package he can take the role of DOCTOR. The ADMIN role can access only the Admin Dashboard, where one can manage all of the apps features besides the vet's medical records (which can only be acceessed by the vets)

UNREGISTERED:

can search for businesses near by
send an email directly to the business
lost and found pet ads
and register to the PetClub and the newsletter

USER:

can upload an image of his pet
can upload an image and the info for the lost/found ad
can add reminders (to do list)
cab rate businesses

ADVERTISED:

all of the USER's abilities plus
he can register a business with images and business info

DOCTOR:

all of the ADVERTISED's abilities plus
he can add clients' pets to his dashboard
and keep an examination record

ADMIN:

can manage users, pets, ads, transactions, subscriptions, categories (pet, business, cities, subscriptions)
can access the Admin's chat (web socket) whice is visible only to the app's admins