Critter Companion

Table of Contents

• Introduction
• Technologies
• Contributors
• Illustrations
• Deployed Page
• Wins
• Challenges & Improvements
• Set Up
• Sources

Introduction

Welcome to Critter Companion an application designed to track the critters you have caught and all the ones you are still looking for in Animal Crossing: New Horizons. It provides information about critter availability, value, and the time of day/year they can be found. With this application, users can easily identify which critters they are missing from their collection and information to help find them.

Technologies

• React
• React Router
• CSS & JSX
• Webpack module bundler
• Cypress end-to-end testing framework
• Postman (for API request testing)
• GitHub Projects

Contributors

• Adriane Sutherland - GitHub LinkedIn

Illustrations

Deployed Page

Visit our deployed Critter Companion

Wins

• Successfully incorporated and leveraged data from an unfamiliar API to enrich the application's capabilities.
• Skillfully devised and adhered to user stories, ensuring that the features met the needs of our intended users.
• Thoroughly examined user flows through comprehensive testing, implementing robust error handling mechanisms to handle any potential issues.
• Worked quickly and efficently in order to produce a well-rounded and clean application.
• Implemented local storage so that changes persist through separate visits to the application.

Challenges & Improvements

• Cypress testing was certainly my biggest challenge, but I did successfully and thoroughly test my application.
  • Possible future improvements and features:
    • Incorperate better responsiveness to allow for clean usage on many devices of different sizes.
    • Adding in the ability to choose what hemisphere the user resides in and have the update the critters avaliability times.
    • Allowing users to be able to sort out what creatures are available at the time as a list rather than searching each critter for its availability.

Set Up

1. Fork the repository to your GitHub account.
2. Copy the SSH key from GitHub by navigating to the code dropdown.
3. Using the terminal, run the following command: git clone [SSH key here].
4. Change into the repository directory: cd critter-companion.
5. Open the repository in your preferred code editor, such as Visual Studio Code.
6. Install the necessary dependencies by running: npm install.
7. Start the application by running: npm start.
8. Click the hyperlink where the project is running to launch the application in your web browser, or enter http://localhost:3000/ into your web browser's address bar.

Sources

• MDN
• W3Schools
• React Docs
• Cypress Docs