Skip to content

Fluffy Paws Shelter: The Transparent, Reliable & Susceptible Animal Shelter System

Notifications You must be signed in to change notification settings

ayseceyda/2020-bootcamp-team-6

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

86 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Fluffy Paws Shelter: The Transparent, Reliable & Susceptible Animal Shelter System

Team-6

Members:

  • Atakan Güven
  • Ayşe Ceyda Ölmez
  • Hilmi Cihan Meral
  • Özge Kocaoğlu
  • Tolga Sarıuslu

Mentor: Alihan Bilgin

About Fluffy Paws

Fluffy Paws Shelter, is an internet application based on up-to-date data that gathers official institutions, volunteer organizations and those who want to own animals under one roof, based on improving the living conditions of shelter animals.

In our country, stray animals face considerable ratios of violence, assault and death. The shelters have conspicuous problems, such as:

  • Overpopulation,
  • Hunger,
  • Lack of Space,
  • Illegal Euthanasia and death ratio.

The designed system aims to build a solid bridge between shelter animals and humans. Considering that the content of the project extends to all areas of life such as education, social life and health, in the long term, the negative situations such as abandonment, violence and cruelty inflicted on stray animals will be prevented.

The objectives of Fluffy Paws Shelter are listed as follows:

  • Providing solutions to the ongoing problems of stray animals with modern and contemporary suggestions,
  • Provide a reliable match between shelter animals and their prospective owners, approved by experts,
  • To make a permanent ownership operations in animal shelters traceable,
  • Preventing illegal sales in pet shops and through social media,
  • Raising awareness about animal rights in the community and promoting the concept of volunteerism in animal shelters.

Fluffy Paws Shelter application follows these steps to get adopt a pet:

Step 1: Applicant fills a form which includes a detailed house plan info, his/her living conditions, working hours and family info.

Step 2: The application form is examined and an interview is carried out, if approval is obtained from experts for a possible match.

Step 3: Approval is given, if a harmony is caught between the pet and the prospective owner at the end of the interview. In the next process, in order for the pet to adapt to ownership, they are vaccinated by experts and the health report is completed.

Fluffy Paws Shelter Style Guide

This document serves as the complete naming definition of this project. In this style guide inspired by Java™ Programming Language style guide. This guide covered span only aesthetic issues of formatting.

Guide Notes

Naming

Naming would be a clear event to people on a different team.

File Names

Examples of the acceptable file names, in javascript:

personal-info.js ListItem.js AnimalListItem.jsx

in Java Spring Boot:

AnimalNotFoundException.java ShelterApplication.java

Type Names

Type names start with uppercase and new words can’t start with underscores.

// classes and structs
class  { ...
class AnimalService { ...
struct AnimalProperties { ...;
// enums
enum class UserRoles { ...

Variable Names

Private variable names start with lowercase but no underscores and public props start with lowercase if variables contain more than one letter than the second one starts with uppercase.

private int weight;
public String getGender()

Constant names a leading ‘’p’’ following because of our project name by mixed case. Underscores can be used as separators in the rare cases.

    const{username, password}...

Function Names

Functions have to start with a uppercase and following letters also have to start with uppercase. But in the mixed cases and service classes can use function like this:

getAllAnimals(),geAnimalsbyId()...

Package Names

Package names should have to follow java original style guide.

com.package.shelter.model…

Enumerator Names

All enum types should have to start with lowercase and following letters start with uppercase.

Comments

Comments could add a code following ways:

To add ‘’TO DO: somenting’’ To desc flow of the class of method.

Analysis Report

FR1

fr2

use cases

uc1-2

uc3

uc4

uc5

uc6

uc7-8

uc9-10

About

Fluffy Paws Shelter: The Transparent, Reliable & Susceptible Animal Shelter System

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published