Skip to content

taylortdixon/abfishing

Repository files navigation


Logo

AB Fishing

A website dedicated to providing up to date information on the fishing regulations for rivers and lakes in Alberta.

View site · Report an Issue

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. License
  6. Contact

About The Project

Product Image

There are many lakes and rivers in Alberta to fish in. Each waterbody has it's own disinct rules on when to fish, what can be kept, and what kind of bait to use.

Details Image

These regulations are set and published by the Alberta Government. However, the format that it's published is a pdf version of a printed magazine, which is not very friendly to a user reading on a screen or phone. Furthermore, trip planning or comparing one lake to another is a real pain.

AB Fishing was created with this in mind:

  • It should be very easy for a user to find a waterbody they are looking for.
  • Fishing regulations should be presented in an easy to digest format that is accessible for the amateur angler.
  • The published regulations from the Alberta Government are the absolute source of truth. This is key. The data served to the client can be completely replaced upon updating from the province regulations.
  • Where possible, try to link back to the section on the official government site so the user can view the official regulations if they need to.

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

yarn install

Fetching Latest Regulations

The parsing of government regulations is automated and can be run with the following steps:

  1. Install local dependencies
  2. Run yarn parse, which fetches latest regulations from the remote site, parses the info from the PDFs, then writes to local regulations file.
  3. Review changes to ensure they make sense

(back to top)

Roadmap

  • Setup regulations parser to run on interval and notify automatically when changes exist
  • Migrate to emotion js
  • Investigate migrating table to list component since most users are mobile
  • Add favorite waterbody feature

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Taylor Dixon - Email Me

(back to top)