Skip to content

Latest commit

 

History

History
31 lines (27 loc) · 1.42 KB

README.md

File metadata and controls

31 lines (27 loc) · 1.42 KB
Raw

Endangered Animals

This repository is the front-end interface for the Software Engineering Group #22. We build off of a React-Boostrap framework in order to combine different data sets into one, meaningful website. In our case specifically, we've compiled information and rich multimedia sources to show concise information on endangered animals and the environments they exist in.

Getting Started

Please visit our website or read our technical report to understand how to clone this website for personal use.

Understanding this repository

Use the following hierarchy to understand the layout of this repository for where you can get started. Only the most relevant files are shown.

   .
   |-app             # Stores mandatory files as required by IDB3 specs
   |---models.py
   |---tests.py
   |
   |-selenium
   |---tests.py      # Front-end unit tests
   |
   |-front-end
   |---components    # React base components folder; no code here has been modified
   |---dev
   |-----src         # Source for our development code. All front-end interface is based on these files
   |
   |-Dockerfile      # Docker config
   |-Poker.csv       # User stories aimed for
   |-Postman.json    # Unit tests
   |-Report.pdf      # Technical report
   |-UML.pdf         # Database design
   |-apiary.apib     # Template for Apiary documentation