A personal portfolio website showcasing projects, skills, and contact information.
- Demo
- Features
- Tech Stack
- Getting Started
- Usage
- Folder Structure
- Scripts
- Contributing
- License
- Contact
- Responsive layout for mobile, tablet, desktop
- Showcases projects with descriptions and links
- Skills section
- Contact form or contact details
- Smooth scrolling / navigation
- Frontend: HTML5, CSS3, JavaScript / TypeScript
- Framework / Build Tool: Vite
- Styling: Tailwind CSS
- Linting: ESLint
- Configuration Tools: PostCSS, TypeScript
To get a local copy up and running:
-
Clone the repo
git clone https://github.com/JyotikaUppar/portfolio-website.git cd portfolio-website
-
Install dependencies
npm install
-
Start development server
npm run dev
-
Build for production
npm run build
- Edit
index.html
, or modify the components insrc/
to update content - Use Tailwind classes / config (
tailwind.config.js
) to change styles or theming - Configure linting via
eslint.config.js
if needed
portfolio-website/
├── src/ # Source files (components, styles, assets etc.)
├── index.html # Entry HTML file
├── package.json # Project metadata & scripts
├── tailwind.config.js # Tailwind config
├── postcss.config.js # PostCSS config
├── eslint.config.js # ESLint config
├── vite.config.ts # Vite configuration
├── tsconfig.json # TypeScript configuration
└── … # Other config files
Script | Description |
---|---|
npm run dev |
Runs local dev server for development |
npm run build |
Builds the site for production use |
npm run lint |
Runs linting checks (if configured) |
npm run preview |
Preview the production build locally |
Contributions are welcome!
- Fork the repo
- Create a feature branch (
git checkout -b feature/YourFeature
) - Make your changes
- Commit your changes (
git commit -m 'Add some feature'
) - Push to the branch (
git push
) - Open a Pull Request
This project is licensed under the MIT License.
👩 Author: Jyotika Uppar 📧 Email: [email protected] 🌐 Portfolio: Portfolio Website
Do you want me to also add a Projects section in the README where you can list out each project (with links/screenshots), or keep it minimal?