Skip to content

evanbones/Town-Square

Repository files navigation

GIT Hackathon 2026 Project

Build Status Python Version React Version License

About The Project

What is "Town Square"? Town Square aims to capture value for small businesses by bridging the gap between clients and producers. Our web application empowers local businesses, non-profits or foundations to source products from local farms and producers while sustainably supporting the local economy.

Tech Stack

  • Frontend: React 19/Vite, Leaflet
  • Backend: Python 3.11, Flask
  • Infrastructure: Docker & Docker Compose
  • CI/CD: GitHub Actions

Team Members

  • Evan Bowness
  • Graeme Bradford
  • Patrick Rinn
  • Patrik Balazsy
  • Amber Hawker

Getting Started

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

Prerequisites

You will need Docker installed on your machine.

Installation & Running Locally

  1. Clone the repository
git clone https://github.com/evanbones/GIT-2026.git
cd GIT-2026
  1. Start the development environment Run the following command from the root directory to build and spin up both the Flask backend and React frontend:
docker-compose up --build
  1. View the application
  • Frontend (Vite/React): Open http://localhost:5173 in your browser.
  • Backend (Flask API): Available at http://localhost:8000.
  • Docs (Swagger): Available at http://localhost:8000/docs.
  1. (Optional) Install pre-commit hooks for automatic linting/formatting
  • Once installed, pre-commit will automatically run before every git commit.
pre-commit install

Diagrams

Database UML Diagram


Code Linting/Formatting (Ruff)

To check code for formatting/linting:

# In the backend/ directory:

# Check for linting issues
ruff check .

# Auto-fix what can be fixed automatically
ruff check . --fix

# Format all code
ruff format .

# Verify everything passes
ruff check .
ruff format --check .

About

Our repository for the 2026 Girls in Tech Hackathon

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors