Skip to content

Commit

Permalink
docs: Updated README file
Browse files Browse the repository at this point in the history
  • Loading branch information
LakioLive committed Jan 14, 2025
1 parent 2b32b81 commit ac42f44
Showing 1 changed file with 97 additions and 0 deletions.
97 changes: 97 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# Portfolio LakioLive

Welcome to the **Portfolio LakioLive**! This project showcases my achievements, projects, and skills.

## Table of Contents

- [Features](#features)
- [Demo](#demo)
- [Installation](#installation)
- [Technologies](#technologies)
- [Contributing](#contributing)
- [Authors](#authors)
- [License](#license)
- [Acknowledgments](#acknowledgments)

## Features

- **Project Showcase**: Display various projects with descriptions and links.
- **Responsive Design**: Optimized for viewing on different devices.
- **About Section**: Provide information about myself.
- **Skills Section**: Highlight my skills and expertise.
- **Animations**: Smooth and engaging animations to enhance user experience.

## Demo

Check out the live demo [here](https://portfolio-lakio-live.vercel.app/).

## Installation

To get a local copy up and running, follow these simple steps:

### Prerequisites

- **Node.js**: Ensure you have Node.js installed. You can download it from [nodejs.org](https://nodejs.org/).

### Clone the repository

```sh
git clone https://github.com/LakioLive/PortfolioLakioLive
cd PortfolioLakioLive
```

### Install dependencies

```sh
npm install
```

### Start the development server

```sh
npm start
```

Open [http://localhost:5173](http://localhost:5173) to view it in the browser.

## Technologies

- **TailwindCSS**: A utility-first CSS framework for rapidly building custom user interfaces.
- **Sass**: A preprocessor scripting language that is interpreted or compiled into CSS.
- **JavaScript**: A programming language that enables interactive web pages and is an essential part of web applications.
- **React**: JavaScript library for building user interfaces.
- **Framer Motion**: A production-ready motion library for React to create animations.
- **Vite**: A build tool that provides a faster and leaner development experience for modern web projects.
- **React Icons**: A collection of popular icons to use in React projects.
- **React Tooltip**: A lightweight tooltip library for React.
- **React Scroll**: A library for smooth scrolling and navigation in React applications.

## Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

### Steps to Contribute

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/YourFeature`)
3. Commit your Changes (`git commit -m 'Add some YourFeature'`)
4. Push to the Branch (`git push origin feature/YourFeature`)
5. Open a Pull Request

## Authors

LakioLive

## License

Distributed under the **MIT License**. See `LICENSE` for more information.

## Acknowledgments

Inspiration, code snippets, etc.

- [awesome-readme](https://github.com/matiassingers/awesome-readme)

---

Thank you for visiting the Portfolio LakioLive! If you have any questions or feedback, please feel free to open an issue or contribute to the project.

0 comments on commit ac42f44

Please sign in to comment.