Porfolio Website

A portfolio website containing all the information about me and my experiences.
Report Bug

Table of Contents

1. About The Project
   • Built With
2. Usage
3. Roadmap
4. Contact
5. Acknowledgments

About The Project

Just a simple website with various aspects. Some of the features are as follows:

• Profile: My personal information and nice image of myself.

• Projects: All the projects pulled directly from GitHub using the GitHub API.

• Experience: Parses the resume.pdf file present in the public directory for work experience. The resume is generated using the TeX file present in resume_builder directory. If you use the same format, the parsing should be successful.

• Contact: How to contact me!

• About: More information about me and what I do.

• Resume: Download or view my resume in PDF format.

• Obviously, light and dark mode possibility.

Note: If you want to use this project, add a .env file in your working directory and add a key VITE_GH_API_KEY with your GitHub API key as the value for it to work.

(back to top)

Built With

The project was built with ReactJS. All the dependencies are listed below:

• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Usage

This is just version 1 of the website so still a work in progress but to run this, the steps are as follows:

Setup

• Install yarn and npm.
• Install firebase and vite.
• Clone the repository, obviously.

Running

• Open the folder in an editor like VSCode.
• Install all dependencies required using the following command:

yarn

• (Optional) Login to firebase and setup the project, follow the steps given by the command:

firebase login

• Finally, run the command to host the server:

yarn dev

Be Aware: There will be various changes and updates will be pushed very often.

(back to top)

Roadmap

• Basic website
• PDF compiling using xu-cheng/latex-action
• PDF parsing using pdf.js
• Load repositories using GitHub API
• Fix UI for some mobile medias
• Fix UI for no-animation medias
• Maybe revamp the website somehow?

See the open issues for a full list of known issues.

(back to top)

Contact

Project Link: https://github.com/lulrai/port_v1

(back to top)

Acknowledgments

• Choose an Open Source License
• Img Shields
• GitHub Pages

(back to top)