Skip to content

stvlynn/EasyProfile

Repository files navigation

EasyProfile

A modern, customizable personal portfolio template with a sleek design and powerful features.

EasyProfile

Buy Me A Coffee

🌟 Features

  • YAML Configuration - Update your portfolio without touching code
  • Bento Grid Layout - Showcase your work with a modern card-based UI
  • Social Media Integration - GitHub, Twitter and custom social links
  • Interactive Maps - Display your locations with integrated maps
  • Dark Mode - Elegant dark theme for optimal viewing
  • Full Responsiveness - Perfect display on all devices
  • Resume Export - Generate PDF resumes with one click
  • Markdown Support - Rich text formatting for content sections
  • Section Navigation - Smooth scrolling between portfolio sections
  • Easter Eggs - Hidden features for curious visitors
  • Custom Cards - Various card types for different content needs
  • Performance Optimized - Fast loading and smooth animations

πŸš€ Technologies

  • Frontend: React + TypeScript
  • Styling: Tailwind CSS
  • Build Tool: Vite
  • Animations: Framer Motion
  • Icons: Lucide React
  • Maps: Leaflet
  • PDF Export: jsPDF + html2canvas

πŸ“‹ Getting Started

Prerequisites

  • Node.js 16+
  • pnpm (recommended) or npm

Installation

  1. Clone the repository
git clone https://github.com/stvlynn/EasyProfile.git
cd EasyProfile
  1. Install dependencies
pnpm install
# or
npm install
  1. Start development server
pnpm dev
# or
npm run dev
  1. Build for production
pnpm build
# or
npm run build

πŸš€ Deployment

Deploying to Vercel

Deploy with Vercel

πŸ”§ Configuration

EasyProfile uses a central YAML configuration file located at /public/config/profile.yaml. This allows you to update your portfolio content without touching any code.

Configuration Sections

  • Meta Information - Title, favicon, description
  • Sections Order - Control which sections appear and in what order
  • Personal Information - Name, avatar, tagline, email
  • Social Media Links - Connect your various online profiles
  • Bento Cards - Customizable grid of information cards
  • Projects - Showcase your work with descriptions and links
  • Experience - Professional history and achievements
  • Education - Academic background
  • Tech Stack - Technical skills with proficiency levels
  • Easter Eggs - Hidden features to delight visitors

Example Configuration

meta:
  title: "Your Name - Position"
  description: "Personal portfolio showcasing skills and experience"
  favicon: "/avatar.jpg"
  resumeExport:
    enabled: true
    sections:
      profile: true
      experiences: true
      # ...

profile:
  name: Your Name
  tagline: Web Developer & Designer
  # ...

# More configuration sections...

πŸ” Project Structure

EasyProfile/
β”œβ”€β”€ public/
β”‚   β”œβ”€β”€ config/           # Configuration files (YAML, Markdown)
β”‚   β”‚   β”œβ”€β”€ profile.yaml  # Main configuration file
β”‚   β”‚   β”œβ”€β”€ intro.md      # Markdown content
β”‚   β”‚   └── eggs/         # Easter egg content
β”‚   └── assets/           # Static assets
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ components/       # React components
β”‚   β”‚   β”œβ”€β”€ cards/        # Card components for bento grid
β”‚   β”‚   └── sections/     # Main section components
β”‚   β”œβ”€β”€ config/           # Frontend configuration
β”‚   β”œβ”€β”€ types/            # TypeScript type definitions
β”‚   └── utils/            # Utility functions
β”œβ”€β”€ index.html            # HTML template
└── package.json          # Dependencies and scripts

πŸ’‘ Advanced Usage

Custom Cards

You can create various card types in your Bento grid:

  • GitHub profile cards
  • Twitter cards
  • Map cards (with Leaflet integration)
  • Link cards
  • Text cards
  • Custom cards with your own content

Easter Eggs

Add hidden surprises for visitors:

easterEggs:
  enabled: true
  autoDisplay: true
  eggs:
    - id: welcome
      trigger: "hi"
      content: ./eggs/welcome.txt
    # More easter eggs...

Access them by typing the trigger or using console.log with the trigger word.

πŸ“Š Project Stats

Star History

Star History Chart

πŸ“ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ™ Acknowledgments


Made with ❀️ by stvlynn IMG_4946.JPG

About

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors