https://github.com/haritha99ch/portfolio
My Portfolio. React, TypeScript, Tailwind CSS.
https://github.com/haritha99ch/portfolio
eslint portfolio powershell react tailwindcss typescript
Last synced: about 1 year ago
JSON representation
My Portfolio. React, TypeScript, Tailwind CSS.
- Host: GitHub
- URL: https://github.com/haritha99ch/portfolio
- Owner: haritha99ch
- Created: 2023-09-07T16:40:44.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-01T04:18:57.000Z (almost 2 years ago)
- Last Synced: 2025-01-09T06:53:16.364Z (about 1 year ago)
- Topics: eslint, portfolio, powershell, react, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://haritha99ch.github.io/portfolio/
- Size: 2.67 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Portfolio Project
This project uses React, TypeScript, Vite, and Tailwind CSS to create a personal website. The UI design of this portfolio project is inspired by [ByteGrad/portfolio-website](https://github.com/ByteGrad/portfolio-website).
## Prerequisites
Before you begin, ensure you have met the following requirements:
- You have installed [Node.js and npm](https://nodejs.org/en/download).
- You have installed [Powershell Core](https://github.com/PowerShell/PowerShell/tree/v7.3.6#get-powershell).
## Setting Up and Running the Project
1. Clone this repository to your local machine.
2. Navigate to the project directory.
3. Install the project dependencies by running `npm install`.
4. Start the development server by running `npm run dev`.
Your site should now be accessible at `http://localhost:5000`.
## Data
This portfolio is powered by data you provide through a series of PowerShell scripts that prompt for your input:
- `npm run add-details`: Prompts you to enter your personal details and saves them to a JSON file.
- `npm run add-skills`: Prompts you to enter your skills and saves them to a JSON file.
- `npm run add-project`: Prompts you to enter your project details and saves them to a JSON file.
- `npm run add-milestone`: Prompts you to enter your milestone details and saves them to a JSON file.
These scripts allow for easy updating of your portfolio's content.
## Deployment
This project uses the `gh-pages` package for deployment to GitHub Pages. After running the build script with `npm run build`, you can deploy the website with `npm run deploy`. This will push the contents of the `dist` directory (created by the build process) to the `gh-pages` branch of your repository, which GitHub Pages will serve as a website.
In your `package.json` file, make sure the `homepage` field points to the correct GitHub Pages URL:
```json
{
"homepage": "https://.github.io/",
}
```
Replace with your GitHub username and with the name of your GitHub repository.
## Acknowledgments
This UI design is inspired by the [ByteGrad's portfolio website](https://github.com/ByteGrad/portfolio-website). A big thank for the inspiration!