🪶 BigBirds 🪶

updated: 07/15/2021

---

Table of Contents

• Introduction
• Features
• Technologies
• Artist Credits
• Contributions
• Authors

---

Introduction

This project is for the new birders of Colorado who are overwhelmed by field guides and options. If you're just starting, you're not worried about the difference between a sanderling and semipalmated sandpiper anyways.

This app provides a top 30 species list of your area. When you see one, check it off! Click to view details about these birds, too. You will see an accumulated list of viewed birds & when you checked them off. As you gain confidence in your identification stills, the more birds you'll check off and soon, you'll take flight into more advanced options such as eBird, Merlin, and the Audubon's Society's apps.

Originally, this project was built for a project with Turing School of Software & Design. See rubric here.

Features

To view please:

• Click here
• Developers, please see To Contribute

Categories:

• Home Page

• Top 30 List

• Seen List

• Updating Lists

• Viewing Details

• Cypress User Flow Testing

Home Page

Example of Home Page

Top 30 List

Example of Top 30

Seen List

Example of Seen List

Updating Lists

Example of Updating Lists

Viewing Details

Example of Top 30

Cypress User Flow Testing

Testing the UX & UI of our app.

Example of Cypress Experience

Technologies

• React
• Router
• Cypress for E2E Testing
• CSS
• HTML
• Webpack
• WAVE for accessibility auditing
• Lighthouse accessibility auditing

Artist Credits

Thanks to allaboutbirds.org for their photo credits.

Future Iterations

I would like to ensure a proper link is created for the "Guess this Bird". I feel as if it would improve user experience if they could click this bird and view the details. 03/29/2021

Additional look at SAD path testing and stubbing of the API calls should be applied.

The biggest refactoring would be surrounding creating an additional backend for user data to be posted rather than relying on localStorage as I temporarily have.

AuthO applied so people may create their own account!

More specifics about future work or refactoring can be found in this projects GH issues.

Contributions

Thank you Alice Ruppert, Kristen Bair, Leta Keane, and Scott Ertmer for their time and patience.

To Contribute

If you'd like to contribute to the code, please complete the following steps:

• clone this repo locally: git clone git@github.com:gaj23/bigbirds.git <renameHere>
• API documentation & endpoints are here
  • You Will Need A Key
  • Please follow the steps outlined in the eBird API documentation for this
• from there please create a new branch following this pattern: git checkout -b initials/feature-fix/focus-of-branch
• cd into your local copy and run npm install
• Use Cypress for testing
• check that the following key-value pair in scripts is in your package.json
• "cypress": "cypress open"
• if not please download Cypress with npm i -D cypress and add the above to scripts.
• contribute as you'd like and push up your work for review Thank you.

Author

Gabrielle Joyce GH