Introduction

• Add your project logo.
• Write a short introduction to the project.
• If you are using badges, add them here.

📒 Index

• About
• Usage
  • Installation
  • Commands
• Development
  • Pre-Requisites
  • File Structure
  • Build
  • Deployment
• Community
  • Contribution
• FAQ
• Resources
• Gallery
• Credit/Acknowledgment
• License

🔰 About

Portfolio website for my self made in react using vite and typescript

⚡ Usage

How to use this project

🔌 Installation

• Clone this repo
• Install packages

$ npm install

📦 Commands

• Start project

$ npm run dev

🔧 Development

📓 Pre-Requisites

List all the pre-requisites the system needs to develop this project.

• nodejs
• Code editor ( VSC, Webstorm )

📁 File Structure

.
├── src
│   ├── assets
│   │   └── react.svg
│   ├── images
│   │   ├── icons
│   │   │   ├── shrink-button.png
│   │   │   └── umbrella.png
│   │   ├── logo_144.png
│   │   └── Untitled-1.psd
│   ├── App.css
│   ├── App.tsx
│   ├── index.css
│   ├── main.tsx
│   └── vite-env.d.ts
├── index.html
├── package.json
├── tsconfig.app.json
├── tsconfig.json
├── tsconfig.node.json
├── vite.config.json
└── README.md

🔨 Build

• Run command to build project

$ npm run build

🚀 Deployment

Build the project and host it on any hosting platform.

🌸 Community

It's open-source project you can use is as template for your portfolio website.

🔥 Contribution

Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project.

1. Report a bug
   If you think you have encountered a bug, and I should know about it, feel free to report it here and I will take care of it.

2. Request a feature
   You can also request for a feature here, and if it will viable, it will be picked for development.

3. Create a pull request
   It can't get better then this, your pull request will be appreciated by the community. You can get started by picking up any open issues from here and make a pull request.

If you are new to open-source, make sure to check read more about it here and learn more about creating a pull request here.

❓ FAQ

You can optionally add a FAQ section about the project.

📄 Resources

React Vite

📷 Gallery

SOON

🔒 License

MIT (c) 2024 FojciolPortfolio