Survivor Stats

A visual snapshot of each castaway's status at the end of each episode of Survivor.

---

Installation

Prerequisites

• Node Package Manager (npm)

Clone

• Clone this repo to your local machine using https://github.com/zlaughton/survivor-stats.git

Setup

1. For both frontend and backend, change to the respective directory, install the dependencies, then start with npm start

$ cd frontend
$ npm install
$ npm start

$ cd backend
$ npm install
$ npm start

2. Access the frontend at localhost:3001, and backend at localhost:5000

Note: The frontend can be run locally, connecting to the hosted backend on the internet. The backend, however requires access to a database. Currently, there is not a public database of the Survivor Stats data available for local testing.

---

Features

• Responsive - usable on both desktop and mobile devices
• Select an episode of any season available on the database to see...
  • Current castaways and their tribe
  • Current advantages
  • Former tribes
  • Former voted out castaways and jury members

Usage

Backend

Use the following URL endpoints to collect data in a JSON response:

• backend-url/seasons - Get available seasons in the database
• backend-url/?season=<season-number> - Get the episode data for the specified season

Built with

• Frontend
  • Create React App
• Backend
  • Node.js
  • Express
  • PostgreSQL

---

Contributing

Feel free to fork, clone, and submit pull requests! Check out the "issues" to see what I'm looking to add, or email me at [email protected] if you have any cool ideas to pitch!

---

Authors

Zak Laughton
https://github.com/zlaughton