Skip to content

README.md

Latest commit

 

History

History
102 lines (77 loc) · 2.59 KB

README.md

File metadata and controls

102 lines (77 loc) · 2.59 KB

Neo-Brutalism Website

A modern portfolio website built with a neo-brutalism design aesthetic, featuring bold colors, strong borders, and intentional design choices that make a statement.

🚀 Features

  • Neo-Brutalism Design - Bold, intentional aesthetic with strong visual elements
  • React 19 - Built with the latest version of React
  • TypeScript - Type-safe development
  • Tailwind CSS - Utility-first styling
  • Framer Motion - Smooth animations and transitions
  • React Router - Client-side routing
  • Vite - Fast build tool and dev server

📦 Tech Stack

  • Frontend: React 19, TypeScript
  • Styling: Tailwind CSS
  • Animation: Framer Motion
  • Routing: React Router DOM
  • Build Tool: Vite
  • Icons: Lucide React

🛠️ Getting Started

Prerequisites

  • Node.js (v18 or higher recommended)
  • npm or yarn

Installation

  1. Clone the repository:

    git clone https://github.com/Shyamnath-Sankar/Neo-Brutalism-Website.git
cd Neo-Brutalism-Website

  2. Install dependencies:

    npm install

  3. Start the development server:

    npm run dev

  4. Open your browser and navigate to http://localhost:5173

📜 Available Scripts

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run preview - Preview production build

📁 Project Structure

├── components/       # Reusable UI components
│   ├── Footer.tsx
│   ├── Hero.tsx
│   ├── Marquee.tsx
│   ├── Navigation.tsx
│   ├── NeoButton.tsx
│   ├── ProjectCard.tsx
│   ├── RevealCard.tsx
│   └── ScrollToTop.tsx
├── pages/           # Page components
│   ├── About.tsx
│   ├── Approach.tsx
│   ├── Contact.tsx
│   ├── Experimental.tsx
│   ├── Home.tsx
│   ├── ProjectDetail.tsx
│   └── Work.tsx
├── data/            # Data files
│   └── projects.ts
├── public/          # Static assets
├── App.tsx          # Main application component
├── index.tsx        # Application entry point
└── index.css        # Global styles

🎨 Design Philosophy

This project embraces the neo-brutalism design trend, characterized by:

  • Bold, contrasting colors
  • Strong borders and shadows
  • Intentionally "raw" aesthetic
  • Playful yet purposeful design elements

📄 License

This project is open source and available under the MIT License.

👤 Author

Shyamnath Sankar