Skip to content

Latest commit

 

History

History
154 lines (97 loc) · 5.36 KB

README.md

File metadata and controls

154 lines (97 loc) · 5.36 KB

At-Risk Animals

June 18th, 2020

By Julia Seidman, Nitun Datta, Nathan Watkins-Hoagland and Eric Settels

Description

This application is an educational site focused on endangered and vulnerable animals in North America. The site was created using C#/.Net. The UI makes use of SVG files for interactive maps. Users can view a set of animals for each country (US, Mexico & Canada), and then select an individual animal to view details. Information primarily comes from the IUCN RedList API.

This application is meant to be viewed in the browser. It will need a .NET Core Sdk 3.1 or 2.2 & ASP.Net 3.1 or 2.2 download.

Setup/Installation Requirements

Make sure you have git version control installed on your computer.

  1. Click the green 'Clone or Download' button and copy the link / download the zip
  2. Open terminal and type... or skip to #4 if you downloaded the zip

Windows

cd desktop

Mac & linux

cd ~/Desktop
  1. in terminal type 'git clone {link to repository} '
git clone {link to repository}
  1. If you downloaded the zip then extract all onto your desktop
  2. Open the folder with VSC or an equivalent
  3. Install .NET Core using this link
  4. Then Run the code below in the terminal to confirm installation
dotnet -- version
  1. In the terminal enter to confirm the proper version installed
dotnet tool install -g
dotnet-script
  1. Download ASP.NET Core To enable live viewing on a local server
  2. You will need to create a file in the root directory of the project run in powershell
new-item appsettings.json
  1. Open project, navigate to the containing folder of the project & Run the code below to confirm build stability
dotnet run build
  1. Within that same containing folder Run dotnet watch run To open a live server w/auto updated viewing

  2. Enjoy

Specs

Behavior Driven Development Spec List

At-Risk Animals

Behavior Input Output
The user can view a map of N. America and get info about the biomes of the 3 countries 'http://localhost:5001/ 'Map with hovering text'
The user can click on a country to see a list of selected animals 'http://localhost:5001/Animals/Index?country=US' '"Cards" for each animal with picture, name & link'
The user can click on a selected animal to see details 'http://localhost:5001/Animals/Detail?name=Leopardus%20pardalis' 'Page with animal details generated by API'
Pages are cached so that after a user visits a country index or individual animal once, it will load faster for subsequent refreshes 'http://localhost:5001/Animals/Index?country=US' 'Loads faster 2nd time'
The user can visit links from home index for additional info 'click link to Nature Conservancy' 'Redirect to Nature.org'

Known Bugs

N/A - 6/18/2020

GitHub / gh-pages

https://github.com/juliaseid/EndangeredAnimals

WiseFool92.github.io/EndangeredAnimals

Support

Email: [email protected]

Email: [email protected]

Email: [email protected]

Email: [email protected]


Built With

Useful tools





License

This project is licensed under the MIT License

Copyright (c) 2020 Nathan Watkins-Hoagland, Eric Settels, Julis Seidman, Nitun Datta