Skip to content

A web-based app accessible via desktop/mobile browsers, providing a map and information about campus green spaces, plant species, and care tips. The main goal is to encourage students to engage with nature.

License

Notifications You must be signed in to change notification settings

Niveusgh/Campus-greenspace-explorer

Repository files navigation

CampusGreen: Interactive Green Space Explorer

Overview

CampusGreen is a mobile-friendly web application designed to help university students and staff discover and learn about green spaces on campus. It provides an interactive map, detailed plant information, and interesting historical facts about the campus environment.

Features

  • Homepage: A welcoming entry point to improve user experience.
  • Interactive Campus Map: Explore green spaces with a touch-friendly interface.
  • Green Space Details: Learn about different types of green areas (gardens, groves, lawns).
  • Plant Species Information: Discover native and notable plants in each green space.
  • Historical and Fun Facts: Engage with interesting stories about plants and spaces.
  • Basic Care Tips: Access simple plant care instructions (optional feature).
  • UK Tree Integration: Access official University of Kentucky tree inventory data
  • Custom Tree Submissions: Add and track user-identified trees on campus

Technology Stack

  • Backend: Python with Flask
  • Frontend: React, HTML5, CSS3, JavaScript
  • Database:
    • SQLite for user submissions
    • CSV integration for UK tree inventory
  • Mapping: Leaflet.js, React-Leaflet
  • Additional Libraries:
    • Flask-SQLAlchemy for database management
    • Pandas for data processing
    • Vite for frontend build tooling

Data Sources

The application uses two main data sources:

  1. UK Tree Inventory: Official tree data from the University of Kentucky's Urban Forest Initiative
  2. User Submissions: Custom tree identifications submitted by users

Resource Links

Getting Started

Prerequisites

  • Python 3.7+
  • Node.js 18+
  • pip (Python package installer)

Installation

You can access Campus Greenspace Explorer in two ways:

1. Online Version

Visit campusGreen.pythonanywhere.com to use the application directly in your browser.

2. Local Installation

For detailed installation instructions, see INSTALLATION.md

  1. Clone the repository:

    git clone https://github.com/niveusgh/campus-greenspace-explorer.git
    cd campus-greenspace-explorer
  2. Set up a virtual environment:

    python -m venv venv
    source venv/bin/activate  # On Windows use `venv\Scripts\activate`
  3. Install required packages:

    pip install -r requirements.txt
  4. Set up the database:

    python init_db.py     # Init database and import UKTrees.csv (one-time setup)
  5. Build frontend and run the application:

    python app.py
  6. Open a web browser and navigate to http://localhost:5000

Usage

  • Open the app on your mobile device or desktop browser.
  • Explore the interactive map to find green spaces on campus.
  • Tap on map markers to view information about each space.
  • Browse plant species information and historical facts.
  • Access care tips for plants by tapping the designated icon.
  • If available, explore the history of specific green spaces by tapping the designated icon.

Contributing

We welcome contributions to CampusGreen! Please read our CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Acknowledgments

  • University of Kentucky for providing data on campus green spaces.
  • Urban Forest Initiative

Contact

Team 0x22

Project Link: https://github.com/Niveusgh/Campus-greenspace-explorer

About

A web-based app accessible via desktop/mobile browsers, providing a map and information about campus green spaces, plant species, and care tips. The main goal is to encourage students to engage with nature.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published