Portfolio Project

This project utilizes the GitHub API to load public projects from your GitHub account. It also supports adding custom projects through a custom JSON file.

Tech Stack

• React (initialized using Create React App): To initialise the portfolio.
• Tailwind CSS is used for styling purpose.
• Headless UI React for making use of components like Dropdown and ListBox
• react-syntax-highlighter A plugin used by react-markdown to highlight code syntax
• rehype-raw plugin to parse the tree (and raw nodes)
• rehype-sanitize plugin to sanitize HTML.
• remark-gfm plugin to support GFM (autolink literals, footnotes, strikethrough, tables, tasklists).
• react-markdown React component to render markdown.

Installation

Prerequisites

• Node.js version 20.9.0 or higher is recommended.

Clone the Repository

git clone https://github.com/himanshu077/my-portfolio.git
cd my-portfolio

Install Dependencies

npm install

Set Up Environment Variables

Create a .env file in the root directory and add the following environment variables:

REACT_APP_GITHUB_USERNAME=your_github_username
REACT_APP_GITHUB_API_KEY=your_github_api_key

Run the Project

npm start

The project will be available at http://localhost:3000.

Live URL

Check out the live version of the project at: Live URL

Contributing

Feel free to open issues or submit pull requests. Contributions are always welcome!

License

This project is licensed under the MIT License.

This README.md should provide a comprehensive guide for anyone looking to understand, install, and run your portfolio project.