Austens-Wedding-Guide/README.md

Jane Austen Literary Analysis Platform

A comprehensive academic web application dedicated to analyzing Jane Austen's works, themes, and their modern relevance. This platform combines literary analysis with interactive features to provide deep insights into Austen's novels and their contemporary interpretations.

📚 Features

Literary Analysis Tools

• Detailed analysis of Norton Critical Editions
• Theme exploration and character development tracking
• Social commentary analysis tools
• Comparative analysis features

Interactive Components

• Character Relationship Network Visualization
• Chronological Timeline of Works and Adaptations
• Social Class Analysis Tools
• Modern Interpretation Studies

Academic Resources

• Integration with Norton Critical Edition content
• Citation management system
• Critical essay references
• Thematic analysis frameworks

🛠 Tech Stack

• Frontend Framework: React with TypeScript
• Build Tool: Vite
• Styling:
  • Tailwind CSS
  • Shadcn/UI components
• Routing: React Router
• Package Manager: npm

🚀 Getting Started

Prerequisites

• Node.js (v16 or higher)
• npm (v7 or higher)

Installation

1. Clone the repository

git clone [repository-url]

2. Install dependencies

npm install

3. Start the development server

npm run dev

4. Build for production

npm run build

📁 Project Structure

src/
├── components/           # Reusable UI components
│   ├── ui/              # Shadcn UI components
│   ├── layout/          # Layout components
│   ├── analysis/        # Analysis-specific components
│   ├── timeline/        # Timeline components
│   └── network/         # Character network components
├── pages/               # Main route components
├── data/                # Data and constants
├── types/               # TypeScript type definitions
├── hooks/               # Custom React hooks
└── lib/                 # Utility functions

🎨 Design System

Typography

• Headings: Cormorant font family
• Body Text: Lato font family
• Academic emphasis with proper hierarchical structure

Color Scheme

• Primary: Sage
• Secondary: Cream
• Emphasis: [Your accent color]

📱 Supported Features

Novel Analysis

• Northanger Abbey
• Sense and Sensibility
• Pride and Prejudice
• Mansfield Park

Modern Analysis Tools

• Contemporary Retellings Analysis
• Social Class Dynamics
• Character Network Visualization
• Interactive Timeline

🔄 Recent Updates

• Enhanced zoom controls in character network visualization
• Improved type system implementation
• UI enhancements with consistent sage color scheme
• Code cleanup and performance optimizations

🧪 Development

Running Tests

npm run test

Linting

npm run lint

Type Checking

npm run type-check

📖 Documentation

For detailed documentation about components, features, and implementation details, please refer to our Technical Documentation.

🤝 Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request