MbuguaMwaura / wild-life-tracker

This is a repo containing a web application that is used to track animals (endangered or otherwise) within a conservancy

wild-life-tracker

This is a repo containg a web application that is used to track endangered animals within a conservancy

Wildlife Tracker Application

This is a repo containing a basic appication that has been deployed to Heroku.

It is an application where users can: *Add a Species of an animal *Add an Animal *Add a Ranger *Add a Park Location *Add an Animal Sighting *View all animal sightings

Technologies used

• Gradle (JUnit) - To test out the project
• Intellij - To write the code
• Postgres - To create a database
• Heroku and maven - To deploy the Application

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

• Step 1:

  Download Intellij from https://www.jetbrains.com/idea/download/#section=linux

• Step 2:

  Visit my GitHub repository; User name Mbugua Mwaura and clone the following link: https://github.com/MbuguaMwaura/HairSalon You can also download the files into you folder and unzip it to access the files.

• Step 3:

  Open the project with Intellij.

• Step 4:

  Type gradle run in order to run the app from your local machine. The port number will be 4567.

• Step 5:

  Install postgres as shown below:

  sudo apt-get update

  sudo apt-get install postgresql postgresql-contrib libpq-dev

  Once it is done installing run

  sudo -u postgres createuser --superuser $USER
  to create super user. Enter your desire password when prompted. Navigate to your home directory and enter the following command to create the .psql_history in order to save your history:

  touch .psql_history

  Type psql on your terminal to connect to the server:

  psql

• Step 6:

  Restore the database schema (tables and columns) by running the following commands:

  # CREATE DATABASE your_database_name

  $ psql name_of_database < schema.sql

  notice that the second command is run in bash and not on psql

Behaviour Driven Development (BDD)

Behaviour my program should handle	Input Example	Output Example
Inputing an Animal	Lion, young, healthy	creates an animal object
Inputing a Species	Panthera Leo, 121, endangered	creates a species object
Inputing a Ranger	Mary Poppins, 012	creates a ranger object
Inputing a Location	NE Pride Rock	creates a location object
Key in sighting	Select the animal, species,ranger, location	outputs the sighting details and timing

Authors

• Mbugua Mwaura
• Contact information: Phone Number: 0798549950 Email: [e-mail]

License

MIT License

Copyright (c) [2019] [Mbugua MWaura]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.}* Copyright (c) {2019} {Mbugua Mwaura}