Troutlytics is a web application designed for anglers and wildlife enthusiasts in Washington State. It provides comprehensive, up-to-date information about fish stocking across various water bodies, enhancing the angling experience and promoting environmental awareness.
- Data Visualization: Interactive charts and maps showcasing fish stocking data for various species across Washington.
- Species Information: Detailed insights into the habitat and behavior of various fish species stocked in Washington waters.
- Responsive Design: Optimized for both mobile and desktop devices, ensuring a seamless user experience.
- User-Friendly Interface: Easy navigation and intuitive layout, designed for users of all tech levels.
- Hosted With AWS Amplify: Simplified front-end hosting
These instructions will help you get a copy of the project up and running on your local machine for development and testing purposes.
Before running the application, ensure you have the following installed:
- Node.js
- npm (usually comes with Node.js)
Follow these steps to get a development environment running:
-
Clone the repo:
-
Navigate to the project directory:
-
Install dependencies:
npm install
-
Start the development server:
npm run dev
The application should now be running on http://localhost:3000
Running the Tests
To run the automated tests, use the following command:
npm test
Built With
TypeScript - For adding type safety to JavaScript
Next.js - React framework for server-side rendering
SWR - For fetching, error handling, loading, and caching data
Tailwind CSS - For styling
Chart.js - For creating interactive data visualizations
leaflet.js - For creating an interactive map
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests. Versioning
This project is licensed under the MIT License - see the LICENSE.md file for details Acknowledgments
Thanks to the Washington Department of Fish and Wildlife for providing the data. Inspired by the diverse angling community in Washington State. WDFW trout plant data