Longhorn-Journey

Build Badges

• 
• 
• 
• 

Table of Contents

• Concise Description
• Overview
  • Problem Statement
  • Solution
• Key Features and Benefits
• Target Audience
• Getting Started
  • Prerequisites
  • Installation Steps
  • Configuration Requirements
• Architecture
  • High-Level Architecture Overview
  • Key Components
  • Design Principles
• Development Workflow
  • Branch Naming Conventions
  • Conventional Commits
  • Pull Request Process
  • Testing Expectations
  • Contribution Guidelines
  • Code of Conduct
• Available Scripts
• Project Structure
• Deployment
• Open Source License
• Links

Concise Description

Longhorn Journey is a web-based experience designed to guide new students through the history, traditions, and culture of the University of Texas at Austin.Longhorn Journey offers an engaging way to explore key campus landmarks, learn about important traditions, navigate academics, and understand what it means to be a Longhorn.

Overview

Problem Statement:

New students often struggle to adjust to university life, and getting familiar with campus traditions, culture, and key places can be overwhelming.

Solution:

Longhorn Journey provides an interactive and engaging online experience that helps new students learn about the University of Texas at Austin’s history, important landmarks, and campus culture, making their transition easier and more fun.

Key Features and Benefits

• Stories and media on Longhorn traditions, events, and history
• Information on academic resources, student orgs, and support services
• Guided onboarding paths for first-year and transfer students
• Built with accessibility, responsiveness, and scalability in mind

Target Audience

• Incoming first-year students
• Transfer students
• Prospective students and families
• Orientation leaders and First Year Interest Group/ student mentors

Getting Started

Prerequisites

1. Installations:

• Astro
• pnpm
• TypeScript
• Git

Installation steps

git clone https://github.com/Longhorn-Developers/Longhorn-Journey.git
cd Longhorn-Journey
pnpm install
pnpm dev

Configuration requirements

• TBD

Architecture & High-level architecture overview

• Astro for frontend rendering (mostly static with dynamic islands if needed)
• Tailwind CSS for styling
• Markdown or CMS-driven content
• Vercel for deployment and hosting

Key components

• TBD

Design principles

• TBD

Development Workflow

Branch naming conventions + Conventional Commits

We follow the Conventional Commits specification for commit messages. This ensures a consistent commit history and enables automated versioning and changelog generation.

Branch Naming Conventions

<type>/<short-description>

Examples:

• feature/{feature-name}
• fix/{bug-description}
• docs/{documentation-change}

Commit Message

Follow this structure for commit messages

<type>(<scope>): <subject>

Where: type has one of the following:

• feat: New features
• fix: Bug fixes
• docs: Documentation changes
• style: Code formatting only
• refactor: Code changes without behavior change
• test: Adding or updating tests
• chore: Build process or tooling updates

PR process

• Fork or branch from main
• Create a PR with a clear description
• Ensure checks pass (build, lint, test)
• Request review before merging

Testing expectations

• Unit tests for UI components
• Integration tests for feature flows

Contribution guidelines & Code of conduct reference

We welcome all to contribute! Please carefully read our Contributing Guide and Code of Conduct before getting started. All contributors must adhere to our Code of Conduct

Available Scripts

• pnpm dev # Start dev server
• pnpm build # Build project for production
• pnpm preview # Preview production build locally
• pnpm lint # Lint codebase
• pnpm format # Format code using Prettier

Development commands

• TBD

Building commands

• TBD

Testing commands

• TBD

Linting & formatting commands

• TBD

Project Structure

• TBD

Directory organization

Key files and their purposes

Deployment

Environment information

• Hosted on Vercel

Deployment process

• Push changes to GitHub
• Vercel builds automatically from main branch
• Preview Deployments available on every PR

Configuration details

• More details on Astro Docs

Open Source License

Usually MIT but choose as needed as some dependencies may require a different license

links: