-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
41797bc
commit 91c2135
Showing
1 changed file
with
124 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,125 @@ | ||
|
||
```markdown | ||
# π MyPortfolio | ||
|
||
Welcome to **MyPortfolio** β a personal website that showcases my skills, projects, blog posts, and more. Built with modern web technologies, this portfolio is designed to be responsive, visually appealing, and easy to navigate. | ||
|
||
![Portfolio Screenshot](./screenshot.png) | ||
|
||
## π Features | ||
|
||
- **Dark Mode Toggle**: Switch between light and dark themes for an optimized viewing experience. | ||
- **Responsive Design**: Fully responsive on all devices. | ||
- **Interactive Animations**: Smooth transitions and animations for an engaging user experience. | ||
- **Organized Sections**: Separate sections for About, Skills, Projects, Blog, and Contact. | ||
|
||
## π οΈ Tech Stack | ||
|
||
- **Frontend**: React, TypeScript | ||
- **Styling**: Tailwind CSS | ||
- **Icons**: Lucide Icons | ||
- **Build Tool**: Vite | ||
|
||
## π Getting Started | ||
|
||
Follow these instructions to set up the project locally. | ||
|
||
### Prerequisites | ||
|
||
- **Node.js** (v14 or higher) | ||
- **npm** or **yarn** | ||
|
||
### Installation | ||
|
||
1. **Clone the repository:** | ||
```bash | ||
git clone https://github.com/aniruddhaadak80/portfolio.git | ||
cd portfolio | ||
``` | ||
|
||
2. **Install dependencies:** | ||
```bash | ||
npm install | ||
# or | ||
yarn install | ||
``` | ||
|
||
3. **Run the development server:** | ||
```bash | ||
npm run dev | ||
# or | ||
yarn dev | ||
``` | ||
|
||
4. **Build for production:** | ||
```bash | ||
npm run build | ||
# or | ||
yarn build | ||
``` | ||
|
||
5. **Preview the production build:** | ||
```bash | ||
npm run preview | ||
# or | ||
yarn preview | ||
``` | ||
|
||
## π¨ Customization | ||
|
||
To personalize your portfolio, follow these tips: | ||
|
||
- **Update Content**: Edit content in the `src/components` directory (e.g., `Header.tsx`, `About.tsx`, `Skills.tsx`). | ||
- **Add New Projects**: Add your projects in the `Projects` section and customize their appearance in `src/components/Projects.tsx`. | ||
- **Theme and Colors**: Modify colors in the `tailwind.config.js` file for a unique theme. | ||
|
||
## π Project Structure | ||
|
||
```plaintext | ||
MyPortfolio/ | ||
βββ public/ # Static assets | ||
βββ src/ | ||
β βββ components/ # Components (Header, About, Projects, etc.) | ||
β βββ assets/ # Images, icons | ||
β βββ App.tsx # Main app component | ||
β βββ main.tsx # Entry point | ||
βββ index.html # HTML template | ||
βββ tailwind.config.js # Tailwind CSS configuration | ||
βββ vite.config.ts # Vite configuration | ||
``` | ||
|
||
## π Live Demo | ||
|
||
Check out the live version of the portfolio at: [https://yourportfolio.vercel.app](https://yourportfolio.vercel.app) | ||
|
||
## π€ Contributing | ||
|
||
Contributions are welcome! If you have any ideas or improvements, feel free to open a pull request. | ||
|
||
1. Fork the repository | ||
2. Create your branch: `git checkout -b my-feature` | ||
3. Commit your changes: `git commit -am 'Add feature'` | ||
4. Push to the branch: `git push origin my-feature` | ||
5. Open a pull request | ||
|
||
## π§ Contact | ||
|
||
Feel free to reach out if you have any questions or feedback. Connect with me at: | ||
|
||
- **Email**: [[email protected]](mailto:[email protected]) | ||
- **LinkedIn**: [Your LinkedIn Profile](https://linkedin.com/in/yourprofile) | ||
- **Twitter**: [Your Twitter Handle](https://twitter.com/yourhandle) | ||
|
||
--- | ||
|
||
### π License | ||
|
||
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details. | ||
``` | ||
### How to Use | ||
1. **Replace `https://yourportfolio.vercel.app`** with the URL of your deployed portfolio. | ||
2. **Add a screenshot** of your portfolio named `screenshot.png` in the root directory for a preview. | ||
3. **Customize contact links** with your own social media or contact links. | ||
4. **Add or edit sections** based on specific features or unique customizations in your portfolio. |