Austens-Wedding-Guide/TECHNICAL_DOCUMENTATION.md
2024-12-04 16:10:29 -05:00

271 lines
6.1 KiB
Markdown

# Technical Documentation - ENGL 2502: Jane Austen
## Recent Changes
### Character Blogs Removal (Latest Update)
- Removed character blogs feature completely
- Deleted related files:
- `src/data/blog-posts.ts`
- `src/data/blogPosts.ts`
- `src/pages/Blogs.tsx`
- `src/components/BlogPost.tsx`
- `src/pages/BlogPost/BlogPost.tsx`
- `src/types/blog.ts`
- Updated navigation:
- Removed blog routes from routing configuration
- Removed "Character Blogs" from navigation menu
- Removed Character Insights section from homepage
- Cleaned up dependencies:
- Removed unused imports
- Fixed linter errors
- Removed blog-related types from `src/types/index.ts`
## Project Overview
A React-based academic web application focused on analyzing Jane Austen's works, themes, and their modern relevance. The project combines literary analysis with interactive features to provide deep insights into Austen's novels and their contemporary interpretations.
## Tech Stack
- **Framework**: React with TypeScript
- **Build Tool**: Vite
- **Styling**: Tailwind CSS
- **UI Components**: Shadcn/UI
- **Routing**: React Router
- **Package Manager**: npm
## Project Structure
```
src/
├── components/
│ ├── ui/ # Shadcn UI components
│ ├── layout/ # Layout components
│ ├── analysis/ # Analysis components
│ │ ├── NovelAnalysis.tsx
│ │ ├── CharacterAnalysis.tsx
│ │ └── ThemeAnalysis.tsx
│ ├── timeline/ # Timeline components
│ │ ├── InteractiveTimeline.tsx
│ │ └── SocialClassView.tsx
│ ├── network/ # Character network components
│ │ ├── NetworkGraph.tsx
│ │ └── RelationshipView.tsx
│ ├── ErrorBoundary.tsx
│ ├── Footer.tsx
│ ├── Layout.tsx
│ ├── LoadingSpinner.tsx
│ ├── Navbar.tsx
│ ├── Pagination.tsx
│ └── theme-provider.tsx
```
## Navigation Structure
The application uses a focused academic navigation structure:
### Primary Navigation
- Literary Analysis
- Novel Studies
- Character Studies
- Quiz
- Vendors
- Success Stories
- Market Calculator
### Analysis Navigation
- Literary Analysis
- Character Network
- Timeline
- Social Class
### Course Novels (Norton Critical Editions)
- Northanger Abbey (ed. Fraiman)
- Sense and Sensibility (ed. Hershinow)
- Pride and Prejudice (ed. Davidson)
- Mansfield Park (ed. Johnson)
### Modern Analysis
- Contemporary Retellings
- Social Class Analysis
- Character Network
- Timeline
## Key Features
### 1. Novel Analysis
- Detailed analysis of each course novel
- Integration with Norton Critical Edition content
- Theme exploration and character development
- Social commentary analysis
### 2. Interactive Features
- Character relationship network visualization
- Chronological timeline of works and adaptations
- Social class analysis tools
- Comparative analysis features
### 3. Modern Interpretations
- Analysis of contemporary retellings
- Comparative studies with original works
- Social class dynamics in modern context
- Character archetype analysis
### 4. Academic Tools
- Citation integration
- Critical essay references
- Thematic analysis frameworks
- Character development tracking
## UI Components
### Navigation Components
```typescript
interface NavItem {
name: string;
path: string;
description?: string;
}
interface NovelItem extends NavItem {
edition: string;
}
interface ModernItem extends NavItem {
description: string;
}
```
### Analysis Components
- Novel selector with edition information
- Theme exploration interface
- Character relationship visualization
- Social class analysis tools
## Styling
The project maintains its elegant aesthetic while emphasizing academic content:
- Clean, scholarly design
- Consistent typography using Cormorant and Lato
- Sage and cream color scheme
- Responsive layout with mobile-first approach
## Typography
- Headings: Cormorant font family
- Body: Lato font family
- Academic emphasis with proper hierarchical structure
## Best Practices
1. Academic Focus
- Content-first approach
- Integration of course materials
- Proper citation and sourcing
- Critical analysis emphasis
2. Technical Implementation
- TypeScript for type safety
- Component-based architecture
- Responsive design
- Performance optimization
3. User Experience
- Clear navigation structure
- Academic resource organization
- Interactive learning tools
- Mobile-friendly layout
## Future Considerations
1. Enhanced Academic Features
- Integration with additional critical editions
- Expanded analysis tools
- Citation management system
- Academic resource linking
2. Content Expansion
- Additional novel analysis
- More contemporary retellings
- Extended character studies
- Thematic deep dives
3. Technical Improvements
- Performance optimization
- Accessibility enhancements
- Mobile experience refinement
- Search functionality
4. Academic Integration
- Course material alignment
- Research tool integration
- Citation format options
- Study guide features
## Character Network Feature
The character network visualization maintains its technical implementation while focusing on academic analysis:
```typescript
interface CharacterNode {
id: string;
name: string;
novel: string;
socialClass: string;
relationships: Relationship[];
criticalAnalysis: string;
}
interface Relationship {
type: string;
target: string;
description: string;
textualEvidence: string;
}
```
## Timeline Feature
The timeline now emphasizes literary chronology and analysis:
```typescript
interface TimelineEvent {
year: number;
type: "publication" | "writing" | "context" | "adaptation";
title: string;
description: string;
criticalContext: string;
literarySignificance: string;
}
```
## Social Class Analysis
Enhanced focus on academic analysis of class dynamics:
```typescript
interface SocialClassAnalysis {
novel: string;
class: string;
characteristics: string[];
textualEvidence: string[];
modernParallels: string[];
criticalPerspectives: string[];
}
```