Personal Portfolio

Personal Portfolio Website

A simple personal portfolio website.
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

This repository houses the current build of my personal portfolio website. This project was built so as to better represent my abilities in web development (full stack development) and further work as a centralised point to access more information about me. A basic design of the desired web platform can be seen here as designed on Figma.

In brief, the project has been built through the implementation of ReactJS, Tailwind CSS, THREE.js, and Google Cloud Platform (GCP) Firebase. The current build of the website can be seen here, as hosted by Firebase.

(back to top)

Built With

• NodeJS
• @emailjs/browser: ^3.4.0
• firebase: ^9.6.7
• pathseg: ^1.2.1
• react: ^17.0.2
• react-icon-cloud: ^4.0.0
• react-icons: ^4.3.1
• react-modal: ^3.14.4
• react-scroll: ^1.8.4
• react-tsparticles: ^1.41.1
• simpleicons: ^6.10.0

(back to top)

Getting Started

Prerequisites

Please be aware the setup to build and run this website differs respective to each operating system (OS). Furthermore, I'm also assuming that you already have NodeJS and React already installed or available within your environment. After confirming this, you'll need to perform the following steps to prepare your local environment.

• npm

  cd /path/to/your/directory # Navigate to where you want to clone the repository. 
  git clone https://github.com/jamestkelly/personal-portfolio.git # Clone the repository.
  cd /path/to/personal-portfolio # Navigate into the repository.
  npm install # Install the necessary packages.

Installation

1. Clone the repository

   git clone https://github.com/jamestkelly/personal-portfolio.git

2. Install NPM packages

   npm install

3. Run the website locally to verify it works correctly prior to deployment.

   npm run # Run the bot on your local host

4. Build and then deploy the web application to any hosting service you prefer.

   npm run build

(back to top)

Usage

This project can be used as an example or starting point for others looking to design, build, and host their own personal portfolio websites. Additionalyl, it predominantly works to represent my most current abilities as a developer within web frameworks, namely with THREE.js, hosting, and pipelining.

(back to top)

Roadmap

• Design website and UI/UX flow.
• Build individual components:
  • THREE.js sphere to show languages and tools I can use.
  • THREE.js interactable splash art on the landing.
  • Email service.
• Host the website.
• Develop the pipeline for CI/CD.

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". 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

Jim Kelly - [email protected]

Project Link: https://github.com/jamestkelly/personal-portfolio

(back to top)

Acknowledgments

The development of this website was made possible to the standard that it is through some of the following resources.

• Build & Deploy a Personal Portfolio with Tailwind CSS
• Ultimate Tailwind CSS Tutorial

Service Providers

• Firebase

(back to top)