Welcome to Access Amherst's Documentation!

Access Amherst is a web application created to connect Amherst College students through organized, accessible, and diverse event updates on campus. The platform provides real-time information on campus events, allowing students to plan their schedules effectively.

This project is made possible through i2i (Ideas 2 Innovation) initiative, a student-led venture accelerator, at Amherst College.

Overview

Access Amherst aims to make it easier for students to discover and participate in events around the campus, fostering a stronger community.

Getting Started

To clone the app, run in terminal:

git clone https://github.com/ac-i2i-engineering/access-amherst.git
cd access-amherst

Set up a virtual environment and activate it to "containerize" the dependencies:

python3 -m venv env
source env/bin/activate

To run the app locally, run:

pip install -r requirements.txt
cd access_amherst_backend
python manage.py makemigrations
python manage.py migrate
python manage.py runserver

Contents

Contents:

• Event Model
  • Event
• RSS Scraper
  • fetch_rss()
• Email Scraper
  • connect_and_fetch_latest_email()
  • extract_email_body()
  • extract_event_info_using_llama()
  • parse_email()
  • save_to_json_file()
• Database Parser
  • filter_events()
  • get_category_data()
  • get_events_by_hour()
  • get_unique_locations()
• Map Generation
  • add_event_markers()
  • create_map()
  • generate_heatmap()

Additional Resources

For more information on how to contribute, report issues, or request features, please refer to our [GitHub repository](https://github.com/ac-i2i-engineering/access-amherst).