Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
azilRababe authored Oct 27, 2023
1 parent 7496b7a commit 02b334b
Showing 1 changed file with 44 additions and 5 deletions.
49 changes: 44 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,47 @@
# React + Vite
# Portfolio

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
Welcome to my open-source portfolio! This project serves as a showcase of my skills and accomplishments as a developer. You can access the deployed version of my portfolio [here](https://azilrababe.github.io/react-portfolio/).

Currently, two official plugins are available:
## Features

- [@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
- Minimal and modern design.
- Fully responsive layout for a seamless experience across devices.
- Built with Javascript and Tailwind CSS for efficient and flexible development.
- Easily customizable to fit your specific requirements.
- Open source and free to use for personal and commercial projects.

## Getting Started

To use this portfolio as a template for your projects, follow these steps:

1. Clone the repository to your local machine.
```bash
git clone https://github.com/azilRababe/react-portfolio.git

2. Install the necessary dependencies
```bash
npm install
4. Customize the portfolio according to your requirements.
5. Run the portfolio locally using
```bash
npm start

## Contributing
We welcome contributions from the developer community. If you'd like to contribute, please follow these guidelines:
1. Fork this repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and test them thoroughly.
4. Submit a pull request (PR) with a detailed description of your changes.
## License
This project is open source and available under the MIT License.
## Contact
Feel free to contact me with any questions, suggestions, or feedback.
## Roadmap
- Implement additional responsive design features to enhance user experience.
- Integrate a blog section to share development insights and experiences.
- Add more project examples with detailed case studies to showcase diverse skills.

0 comments on commit 02b334b

Please sign in to comment.