Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thomas-basham/trout-tracker-wa-backend

Trout Tracker WA is a comprehensive web application designed to provide updated information about trout stocking in Washington state. This repository contains all the essential backend components of the project, including database management, a Flask API and a web scraper.
https://github.com/thomas-basham/trout-tracker-wa-backend

contributions-welcome contributors data-visualization docker fish fishing flask folium lakes maps python sqlalchemy statistics trout website

Last synced: 28 days ago
JSON representation

Host: GitHub
URL: https://github.com/thomas-basham/trout-tracker-wa-backend
Owner: Thomas-Basham
License: apache-2.0
Created: 2022-05-23T16:11:36.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-08-24T16:47:06.000Z (3 months ago)
Last Synced: 2024-08-24T18:02:15.884Z (3 months ago)
Topics: contributions-welcome, contributors, data-visualization, docker, fish, fishing, flask, folium, lakes, maps, python, sqlalchemy, statistics, trout, website
Language: Python
Homepage: https://trout-tracker-wa-backend.vercel.app
Size: 10.1 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # Trout Tracker WA Backend

**Authors:** Thomas Basham

**Version:** 4.1.1

[trout-tracker-wa-backend.vercel.app](https://trout-tracker-wa-backend.vercel.app/)

[Front End Code](https://github.com/Thomas-Basham/trout-tracker-wa)

![Flask](https://img.shields.io/badge/Flask-23daaf?style=for-the-badge&logo=flask&logoColor=white)

![Postgresql](https://img.shields.io/badge/PostgreSQL-316192?style=for-the-badge&logo=postgresql&logoColor=white)

![Vercel](https://img.shields.io/badge/Vercel-000?style=for-the-badge&logo=Vercel&logoColor=white)

[![Python application](https://github.com/Thomas-Basham/trout-tracker-wa-backend/actions/workflows/python-app.yml/badge.svg?branch=main)](https://github.com/Thomas-Basham/trout-tracker-wa-backend/actions/workflows/python-app.yml)

[![daily-cron](https://github.com/Thomas-Basham/washington-trout-stats/actions/workflows/cron.yaml/badge.svg)](https://github.com/Thomas-Basham/washington-trout-stats/actions/workflows/cron.yaml)

## Introduction

Trout Tracker WA is a comprehensive web application designed to provide updated information about trout stocking in Washington state. This repository contains all the essential backend components of the project, including database management, a Flask API and a web scraper.

### Getting Started

- [With WebScraper](./web_scraper/README.md)

- [With API](./api/README.md)

### Features

- Flask backend for server and API management.

- Data scraping tool for fetching real-time data.

- Comprehensive API for data retrieval.

### Configuration

- Set environment variables in a `.env` file as required.

- Configure the database settings in the respective configuration files.

### Running the Application

Start the Flask server:

```bash

python main.py

```

### Contributions

- [Get started Contributing](./CONTRIBUTING.md)

### Tech Used

- Flask

- Beautiful Soup (Data scraped from [WDFW Stock Report](https://wdfw.wa.gov/fishing/reports/stocking/trout-plants))

- SQLAlchemy

- PostgreSQL Database

- [GitHub Cron Job](https://github.com/Thomas-Basham/washington-trout-stats/actions/workflows/cron.yaml) (To schedule webscraping daily)

- Google Geolocation API (To get lat/lon of lakes)

- Docker

## Resources

[WDFW Stock Report](https://wdfw.wa.gov/fishing/reports/stocking/trout-plants)

[Flask](https://flask.palletsprojects.com/)

[Beautiful Soup](https://www.crummy.com/software/BeautifulSoup/bs4/doc/)

[SQLAlchemy](https://flask-sqlalchemy.palletsprojects.com/en/2.x/quickstart/)

[Docker and NGINX](https://github.com/docker/awesome-compose/tree/master/nginx-wsgi-flask)

[Google Geolocator API](https://developers.google.com/maps/documentation/geolocation/overview)

### Contact

- Developer: Thomas Basham

- Email: [email protected]