An open API service indexing awesome lists of open source software.

https://github.com/pungrumpy/cv

📃 A minimalist CV page
https://github.com/pungrumpy/cv

curriculum-vitae cv nextjs shadcn-ui

Last synced: 17 days ago
JSON representation

📃 A minimalist CV page

Awesome Lists containing this project

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](/public/preview.png)](https://cv.pungrumpy.com/)

![Next.js](https://img.shields.io/badge/Next-black?style=for-the-badge&logo=next.js)
![TailwindCSS](https://img.shields.io/badge/tailwindcss-black?style=for-the-badge&logo=tailwind-css)
![Shadcn/ui](https://img.shields.io/badge/shadcn/ui-black.svg?style=for-the-badge&logo=shadcn/ui)
![Prisma](https://img.shields.io/badge/Prisma-black?style=for-the-badge&logo=prisma)
![TypeScript](https://img.shields.io/badge/TypeScript-black?style=for-the-badge&logo=typescript)
![Supabase](https://img.shields.io/badge/Supabase-black?style=for-the-badge&logo=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](https://nodejs.org/) (v20 or higher)
- [Bun](https://bun.sh/) - Task runner for Node.js projects

### Installation

1. **Clone the repository**:

```bash
git clone [email protected]:PunGrumpy/cv.git
```

2. **Navigate to the project directory**:

```bash
cd cv
```

3. **Install dependencies**:

```bash
bun install
```

### Running the Development Server

Start the development server:

```bash
bun dev
```

Open [http://localhost:3000](http://localhost:3000) in your browser to view the website.

## 📂 Project Structure

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

```plaintext
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

- [x] **Responsive Design**: Optimized for various screen sizes.
- [x] **Dynamic Content**: Easily update and manage content via Prisma.
- [x] **Modern UI**: Sleek design using Shadcn/ui components.
- [x] **Dark Mode**: Toggle between light and dark themes.
- [x] **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](LICENSE) file for details.

---

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