0. Avian Diet Database

A mobile-friendly web page that presents bird diet information using data compiled by Prof. Hurlbert’s
lab in an interactive and easy to digest manner. It does this using data visualizations (e.g. maps, graphs, etc.)
along with interactive filters (e.g. geographic, temporal, taxonomic, etc.) that provide a variety of ways to
explore the relationships between a bird and its diet.

1. Getting Started

Prerequisites

• Git
• npm
• Node.js

Installing

1. Clone the repository

   https://github.com/COMP523FA2020/Frontend.git

2. Run npm install to have all the libraries

   npm install

Running Locally

In the project, you can run

npm run start-dev

to launch a local server to see the unbuilt files live.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

npm run start

Launches the app from the build folder. This will not live-update, run build in order to see updates.

Warranty

These instructions were last tested on Nov. 9th, 2020 by Muyan Pan on Windows 10

2. Testing

npm test

Launches the Jest test suites while file-watching.

Use the options '-- --coverage --watchAll=false' to generate a code coverage report.

3. Deployment

The frontend, backend, and production database are deployed using Carolina Cloud Apps.

When local changes are pushed onto GitHub, the changes will be built automatically,
and the production will be updated.

4. Technologies Used

Frontend

• React
• Apollo Client
• Bulma
• react-vis
• Typescript

Our architecture decision records can be found in the ADR.md file

5. Contributing

Access

New developers will need access to both the GitHub repository and the Trello board
for this project before contributing

Style and code conventions

Use JavaScript linter ESLint

Use JavaScript Standard Style

Follow the OneFlow model and workflow with only master branch in remote repository

Website Link

6. Authors

Frontend

• Teddy Randby
• Muyan Pan

Backend

• Thomas Le

7. TODO

• Refactor with a state management library - like Redux.

8. Licenses

MIT license

9. Acknowledgements

• Professor Allen Hurlbert for providing the R queries and consistent feedbacks
• Jacob Yackenovich for mentoring us weekly and answering our questions