diff --git a/README.md b/README.md index f768e33..02772cd 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,68 @@ -# React + Vite +# Portfolio of Yousif Paulus -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +This is the repository for my portfolio. It serves as a modern, interactive showcase of my projects and skills. -Currently, two official plugins are available: +## Tech Stack +- **Frontend**: React +- **Styling**: [Animate.css](https://animate.style/) (for animations) +- **Backend**: Node.js +- **Font**: Apple's SF Pro +- **Icons**: FontAwesome -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh +## Plugins +- [vite-plugin-svgr](https://github.com/pd4d10/vite-plugin-svgr) (for seamless integration of SVGs as React components) + +## Hosting +- Hosted on [Netlify](https://www.netlify.com/). +- Live version: [yousifpaulus.dev](https://yousifpaulus.dev). + +## Inspiration +The design is inspired by: +- Apple Keynote presentations +- A "tile" theme with dynamic tiles showcasing specific content. + +## Features +- Dynamic and interactive tiles presenting content such as projects, skills, and additional information. +- Animations to ensure a smooth and engaging user experience. +- Modern and minimalist design aligned with Apple's aesthetic. + +## Development +### Prerequisites +Ensure the following tools are installed: +- Node.js +- Vite + +### Installation +1. Clone the repository: + ```bash + git clone https://github.com/yousifpa98/portfolio.git + ``` +2. Navigate to the project directory: + ```bash + cd portfolio + ``` +3. Install dependencies: + ```bash + npm install + ``` + +### Start Development +Run the development server: +```bash +npm run dev +``` +The portfolio will be accessible at `http://localhost:3000`. + +### Build for Production +Create a production build: +```bash +npm run build +``` +The built files will be located in the `dist` folder. + +## Feedback and Contact +If you have any feedback or wish to get in touch, you can reach me at: +- GitHub: [yousifpa98](https://github.com/yousifpa98) + +--- +Enjoy exploring my portfolio! 😊