init commit

README.md

@@ -0,0 +1,54 @@
+# Summary
+
+# Detailed Design
+
+## Functionality
+
+### User Creates an Event
+
+- Fills out form
+- form includes:
+    - Event Address
+    - Event Name
+    - Event Description
+    - Event Start Time
+    - Event End Time
+    - Rain Date
+    - Price
+
+    - Images
+    - Category
+    - Tagging (optional)
+    - RSVP Needed (optio nal)
+    - Contact Info (optional)
+    - Share Email (optional)
+    - Event Size (how many people will go) (optional)
+    - Event Size Maximum (optional)
+- After filling out form:
+    - Direct to event page
+    - Event page allows editing, cancelling
+    - share on all platforms
+
+### User Searches for an event
+- Types in location, or read location
+- Provides radius (default provided)
+- Events populate
+- events are clickable and show more Info
+- ability to say they are going to an event (require login)
+- email event to me, or others
+- share on all platforms
+- user can add event to list of events associated to their account
+- users can filter events by category, tag, date
+- users can comment on events, and post pictures of events that they went to (require login)
+
+## User Flow
+
+## Web Pages
+
+## DB Structure
+
+## API Endpoints
+
+## Authentication
+
+# Dependencies

api/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

api/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class ApiConfig(AppConfig):
+    name = "api"

api/models.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

api/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

api/views.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.

localist/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for localist project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/6.0/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "localist.settings")
+
+application = get_asgi_application()

localist/settings.py

@@ -0,0 +1,119 @@
+"""
+Django settings for localist project.
+
+Generated by 'django-admin startproject' using Django 6.0.6.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/6.0/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/6.0/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/6.0/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "django-insecure-pek1teheggj8zzvtcntp4-u#s_^yc$&a@3f7wi+u%8)g*2xezw"
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "web",
+    "api",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+]
+
+ROOT_URLCONF = "localist.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "localist.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/6.0/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/6.0/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/6.0/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "UTC"
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/6.0/howto/static-files/
+
+STATIC_URL = "static/"

localist/urls.py

@@ -0,0 +1,23 @@
+"""
+URL configuration for localist project.
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/6.0/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+
+from django.contrib import admin
+from django.urls import path
+
+urlpatterns = [
+    path("admin/", admin.site.urls),
+]

localist/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for localist project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/6.0/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "localist.settings")
+
+application = get_wsgi_application()

web/admin.py

@@ -0,0 +1,12 @@
+from django.contrib import admin
+from web.models.category import Category, CategoryAdmin
+from web.models.event import Event, EventAdmin
+from web.models.event_category import EventCategory, EventCategoryAdmin
+from web.models.event_tag import EventTag, EventTagAdmin
+from web.models.tag import Tag, TagAdmin
+
+admin.site.register(Category, CategoryAdmin)
+admin.site.register(Event, EventAdmin)
+admin.site.register(EventCategory, EventCategoryAdmin)
+admin.site.register(EventTag, EventTagAdmin)
+admin.site.register(Tag, TagAdmin)

web/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class WebConfig(AppConfig):
+    name = "web"

web/migrations/0001_initial.py

@@ -0,0 +1,169 @@
+# Generated by Django 6.0.6 on 2026-06-13 19:01
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="Category",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True, null=True)),
+                ("updated_at", models.DateTimeField(auto_now=True, null=True)),
+                ("active", models.BooleanField(default=True)),
+                ("name", models.CharField()),
+                ("description", models.TextField()),
+            ],
+            options={
+                "db_table": "category",
+            },
+        ),
+        migrations.CreateModel(
+            name="Event",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True, null=True)),
+                ("updated_at", models.DateTimeField(auto_now=True, null=True)),
+                ("active", models.BooleanField(default=True)),
+                ("name", models.CharField()),
+                ("description", models.TextField()),
+                ("url", models.URLField()),
+                ("address", models.CharField()),
+                (
+                    "status",
+                    models.CharField(
+                        choices=[
+                            ("scheduled", "Scheduled"),
+                            ("completed", "Completed"),
+                            ("canceled", "Canceled"),
+                        ],
+                        default="scheduled",
+                        max_length=20,
+                    ),
+                ),
+                (
+                    "price",
+                    models.DecimalField(
+                        blank=True, decimal_places=2, default=None, max_digits=10
+                    ),
+                ),
+                ("require_rsvp", models.BooleanField()),
+                ("start_time", models.DateTimeField()),
+                ("end_time", models.DateTimeField()),
+                ("rain_date", models.DateTimeField()),
+                ("email", models.EmailField(max_length=254)),
+                ("phone_number", models.CharField(blank=True, default=None)),
+            ],
+            options={
+                "db_table": "events",
+            },
+        ),
+        migrations.CreateModel(
+            name="Tag",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True, null=True)),
+                ("updated_at", models.DateTimeField(auto_now=True, null=True)),
+                ("active", models.BooleanField(default=True)),
+                ("name", models.CharField()),
+            ],
+            options={
+                "db_table": "tag",
+            },
+        ),
+        migrations.CreateModel(
+            name="EventCategory",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True, null=True)),
+                ("updated_at", models.DateTimeField(auto_now=True, null=True)),
+                ("active", models.BooleanField(default=True)),
+                (
+                    "category",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE, to="web.category"
+                    ),
+                ),
+                (
+                    "event",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE, to="web.event"
+                    ),
+                ),
+            ],
+            options={
+                "db_table": "event_categories",
+            },
+        ),
+        migrations.CreateModel(
+            name="EventTag",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True, null=True)),
+                ("updated_at", models.DateTimeField(auto_now=True, null=True)),
+                ("active", models.BooleanField(default=True)),
+                (
+                    "event",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE, to="web.event"
+                    ),
+                ),
+                (
+                    "tag",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE, to="web.tag"
+                    ),
+                ),
+            ],
+            options={
+                "db_table": "event_tags",
+            },
+        ),
+    ]

web/models/base.py

@@ -0,0 +1,10 @@
+from django.db import models
+
+
+class BaseModel(models.Model):
+    created_at = models.DateTimeField(blank=True, null=True, auto_now_add=True)
+    updated_at = models.DateTimeField(blank=True, null=True, auto_now=True)
+    active = models.BooleanField(default=True)
+
+    class Meta:
+        abstract = True

web/models/category.py

@@ -0,0 +1,23 @@
+from django.db import models
+from django.contrib import admin
+from web.models.base import BaseModel
+
+
+class Category(BaseModel):
+    name = models.CharField()
+    description = models.TextField()
+
+    class Meta:
+        db_table = 'category'
+
+
+class CategoryAdmin(admin.ModelAdmin):
+    search_fields = (
+        'name',
+        'description'
+    )
+
+    list_display = (
+        'name',
+        'description',
+    )

web/models/event.py

@@ -0,0 +1,58 @@
+from django.db import models
+from django.contrib import admin
+from web.models.base import BaseModel
+from enum import StrEnum
+
+
+
+class Event(BaseModel):
+    class Status(models.TextChoices):
+        SCHEDULED = 'scheduled', 'Scheduled'
+        COMPLETED = 'completed', 'Completed'
+        CANCELED = 'canceled', 'Canceled'
+
+    name = models.CharField()
+    description = models.TextField()
+    url = models.URLField()
+    address = models.CharField()
+    status = models.CharField(max_length=20, choices=Status.choices, default=Status.SCHEDULED)
+    price = models.DecimalField(max_digits=10, default=None, blank=True, decimal_places=2)
+    require_rsvp = models.BooleanField()
+
+    start_time = models.DateTimeField()
+    end_time = models.DateTimeField()
+    rain_date = models.DateTimeField()
+
+    email = models.EmailField()
+    phone_number = models.CharField(default=None, blank=True)
+
+    class Meta:
+        db_table = 'events'
+
+
+class EventAdmin(admin.ModelAdmin):
+    search_fields = (
+        'name',
+        'description',
+        'start_time',
+        'end_time',
+        'rain_date',
+        'url',
+        'address',
+        'status',
+        'price',
+        'require_rsvp',
+    )
+
+    list_display = (
+        'name',
+        'description',
+        'start_time',
+        'end_time',
+        'rain_date',
+        'url',
+        'address',
+        'status',
+        'price',
+        'require_rsvp',
+    )

web/models/event_category.py

@@ -0,0 +1,25 @@
+from django.db import models
+from django.contrib import admin
+from web.models.base import BaseModel
+from web.models.event import Event
+from web.models.category import Category
+
+
+class EventCategory(BaseModel):
+    event = models.ForeignKey(Event, on_delete=models.CASCADE)
+    category = models.ForeignKey(Category, on_delete=models.CASCADE)
+
+    class Meta:
+        db_table = 'event_categories'
+
+
+class EventCategoryAdmin(admin.ModelAdmin):
+    search_fields = (
+        'event',
+        'category',
+    )
+
+    list_display = (
+        'event',
+        'category',
+    )

web/models/event_tag.py

@@ -0,0 +1,25 @@
+from django.db import models
+from django.contrib import admin
+from web.models.base import BaseModel
+from web.models.event import Event
+from web.models.tag import Tag
+
+
+class EventTag(BaseModel):
+    event = models.ForeignKey(Event, on_delete=models.CASCADE)
+    tag = models.ForeignKey(Tag, on_delete=models.CASCADE)
+
+    class Meta:
+        db_table = 'event_tags'
+
+
+class EventTagAdmin(admin.ModelAdmin):
+    search_fields = (
+        'event',
+        'tag',
+    )
+
+    list_display = (
+        'event',
+        'tag',
+    )

web/models/tag.py

@@ -0,0 +1,20 @@
+from django.db import models
+from django.contrib import admin
+from web.models.base import BaseModel
+
+
+class Tag(BaseModel):
+    name = models.CharField()
+
+    class Meta:
+        db_table = 'tag'
+
+
+class TagAdmin(admin.ModelAdmin):
+    search_fields = (
+        'name',
+    )
+
+    list_display = (
+        'name',
+    )

web/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

web/views.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.