PunGrumpy/cv-page

๐Ÿ“ƒ A minimalist CV page

โ˜… 2Forks 0TypeScriptGitHub โ†—Compare

Project website โ†—

curriculum-vitaecvnextjsshadcn-ui

README

๐Ÿ“ƒ Curriculum Vitae Website

Welcome to my Curriculum Vitae (CV) website! This single-page application is designed to showcase my professional background, including my skills, education, work experience, and projects.

Curriculum Vitae Website

Next.js TailwindCSS Shadcn/ui Prisma TypeScript Supabase

๐Ÿ› ๏ธ Technologies Used

  • Next.js: A React framework for server-side rendering and static site generation.
  • Tailwind CSS: A utility-first CSS framework for rapid UI development.
  • TypeScript: A statically typed superset of JavaScript.
  • Shadcn/ui: A UI component library.
  • Prisma: An ORM for Node.js and TypeScript.

๐Ÿš€ Getting Started

Prerequisites

Ensure you have the following installed:

  • Node.js (v20 or higher)
  • Bun - Task runner for Node.js projects

Installation

  1. Clone the repository:

    git clone [email protected]:PunGrumpy/cv.git
  2. Navigate to the project directory:

    cd cv
  3. Install dependencies:

    bun install

Running the Development Server

Start the development server:

bun dev

Open http://localhost:3000 in your browser to view the website.

๐Ÿ“‚ Project Structure

Here's an overview of the project's structure:

cv/
โ”œโ”€โ”€ components/       # Reusable UI components
โ”œโ”€โ”€ app/              # Next.js pages
โ”œโ”€โ”€ public/           # Static files
โ”œโ”€โ”€ lib/              # Utility functions
โ”œโ”€โ”€ prisma/           # Prisma schema and migrations
โ”œโ”€โ”€ components.json   # Shadcn/ui component configuration
โ”œโ”€โ”€ tsconfig.json     # TypeScript configuration
โ”œโ”€โ”€ next.config.mjs   # Next.js configuration
โ””โ”€โ”€ package.json      # Project metadata and dependencies

๐Ÿ“‹ Features

  • Responsive Design: Optimized for various screen sizes.
  • Dynamic Content: Easily update and manage content via Prisma.
  • Modern UI: Sleek design using Shadcn/ui components.
  • Dark Mode: Toggle between light and dark themes.
  • Real-time Database Updates: Automatically refresh content on changes.

๐Ÿค Contributing

Contributions are welcome! If you have suggestions for improvements or encounter any issues, please open an issue or submit a pull request.

๐Ÿ“ License

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


Thank you for visiting my CV website! I hope you find it informative and engaging.

Contributors

PunGrumpy

Issues