Skip to content

Commit

Permalink
docs: Updated package.json dependencies and added README.md for project
Browse files Browse the repository at this point in the history
  • Loading branch information
LakioLive committed Feb 3, 2025
1 parent a42255f commit 2afa1dc
Show file tree
Hide file tree
Showing 3 changed files with 601 additions and 35 deletions.
76 changes: 76 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Portfolio Website

Welcome to my portfolio website repository! This project showcases my work, skills, and experience in web development.

## 🚀 Features

- Responsive design
- Smooth animations and transitions
- Interactive UI
- Skills showcase
- Projects showcase

## 🛠️ Tech Stack

- **Frontend:** Sass, TailwindCSS, TypeScript, React, NextJS, Framer Motion (Motion)
- **Deployment:** Vercel
- **Development Tools**: ESLint, Prettier

## 📂 Project Structure

```
lakiolive-portfolio/
│── .github/ # GitHub-specific configurations and workflows
│── public/ # Static assets like images, icons, and fonts
│── src/ # Source code for the project
│ ├── @types/ # TypeScript type definitions
│ ├── app/ # Core application logic and routing
│ ├── components/ # Reusable UI components
│ │ ├── layout # Layout components (header, footer, etc.)
│ │ ├── ui # Common UI elements (buttons, inputs, etc.)
│ ├── lib/ # Utility functions and helper libraries
│── .gitignore # Specifies files and directories to ignore in Git
│── .prettierrc # Prettier configuration for code formatting
│── .vercelignore # Files and directories to ignore during Vercel deployment
│── eslint.config.mjs # ESLint configuration for code linting
│── next.config.ts # Next.js configuration settings
│── package.json # Project metadata, dependencies, and scripts
│── release.config.js # Configuration for automated releases
│── tailwind.config.ts # TailwindCSS configuration for styling
│── tsconfig.json # TypeScript compiler options
```

## 📦 Installation

1. Clone the repository:
```sh
git clone https://github.com/LakioLive/Portfolio
```
2. Navigate to the project directory:
```sh
cd lakiolive-portfolio
```
3. Install dependencies:
```sh
npm install
```
4. Start the development server:
```sh
npm run dev
```

## 📬 Contact

Feel free to reach out via email or social media if you have any questions!

## 🐛 Issues & Contributions

If you encounter any issues, bugs, or have feature suggestions, feel free to:

- Open an issue on GitHub.
- Submit a pull request with improvements.
- Share your feedback to help improve the project!

---

⭐ Don't forget to star the repository if you like it!
Loading

0 comments on commit 2afa1dc

Please sign in to comment.