alireza-jahandoost / Portfolio

A customizable portfolio website written with Laravel and React

Potfolio

An awesome portfolio site, written with laravel and react
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

After some projects, finally, I decided to start my portfolio. I tried to make it as customizable as I can, so that others can use it as well.

The features that are currently supported:

• customizable About me and Contact me sections
• unlimited number of projects to include
• categorizing projects in project sections
• add unlimited number of skills
• categorizing skills into Fluented and Familiar categories
• filtering projects by skills or project sections
• search in projects

The features that I want to be added:

• supporting of having a blog
• showing the pdf version of pdf in landing page
• add a form in Contact me section to communicate easier
• supporting rtl
• supporting multi languages

(back to top)

Built With

• React.js
• Laravel
• Tailwindcss
• Inertiajs

(back to top)

Getting Started

Prerequisites

To run this project in your pc, you need:

• php
• a database server such as mysql
• a web server such as apache
• nodejs and npm, if you want to edit admin panel

Installation

1. Clone the repo

   git clone https://github.com/alireza-jahandoost/Portfolio

2. Move to the directory

   cd Portfolio

3. Configure .env file( you only need to to write database information )

   cp .env.example .env

4. Install php dependencies

   composer install

5. Generate key

   php artisan key:generate

6. Create database tables

   php artisan migrate

7. Install js dependencies ( if you want to edit styles or admin panel )

   npm install
   npm run watch

(back to top)

Usage

To run the project, you need to serve it:

php artisan serve

Then, you can login to admin account in http://localhost:8000/login url.

username: [e-mail]

password: password

(back to top)

Roadmap

• customizable About me and Contact me sections
• unlimited number of projects to include
• categorizing projects in project sections
• add unlimited number of skills
• categorizing skills into Fluented and Familiar categories
• filtering projects by skills or project sections
• search in projects
• supporting of having a blog
• showing the pdf version of pdf in landing page
• add a form in Contact me section to communicate easier
• supporting rtl
• supporting multi languages

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". If you do not have a specific idea, and you want to contribute, you can choose one of the issues and try to complete that one. Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Alireza Jahandoost - [e-mail]

Project Link: https://github.com/alireza-jahandoost/Portfolio

(back to top)