📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 📝 License

📖 Portfolio

Portfolio is my personal portfolio project I tried to demonstrate my thoughts, goals, projects, contact info.

🛠 Built With

Tech Stack

• Vite | TypeScript | React | Tailwindcss | React-router | GitHub Actions | Eslint | Prettier

Key Features

• Global State management
• Full responsive
• Routing
• Use linters & coder formatter
• Animated background

(back to top)

🚀 Live Demo

• Live Demo

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Browser -- Firefox is a good option.
• Text Editor -- Vscode is a good option.
• Node

Setup

Clone this repository to your desired folder:

  git clone https://github.com/M-AminAlizadeh/Portfolio.git portfolio
  cd portfolio

Install

Install this project with:

  npm install

Usage

To run the project, execute the following command:

  npm run dev

Run tests

To run tests, run the following command:

  npm run lint & npm run format

Deployment

You can deploy this project using different platform:

• gh-pages
• Vercel
• Netlify

(back to top)

👥 Authors

• GitHub
• LinkedIn

(back to top)

🔭 Future Features

• Add unit testing

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project give it a ⭐

(back to top)

📝 License

This project is MIT licensed.

(back to top)