Skip to content

austin-cavanagh/portfolio

Repository files navigation


Table of Contents
  1. Overview
  2. Built With
  3. Getting Started
  4. Contributing
  5. Contact
  6. License

Overview

Screenshot displaying an overview of the solar system

Welcome to my portfolio, designed as an interactive solar system to reflect my interest in space and talents as a developer.

Highlights:

  • 3D Solar System: Explore a detailed 3D environment showcasing each planet in our solar system
  • Responsive Design: Ensures a seamless and visually consistent experience across all devices
  • Dynamic Interactivity: Engage with intuitive elements that respond to your interactions

I hope you enjoy exploring my portfilio as much as I enjoyed creating it!

(back to top)

Built With

JavaScript TypeScript HTML5 CSS3 Tailwind CSS React Redux Redux Toolkit Docker AWS AWS EC2 AWS ECR Three.js GLSL

(back to top)

Getting Started

This section provides instructions on how to get a local copy of the portfolio up and running.

Prerequisites

Before installing, make sure you have the following tools installed:

  • Node.js: The runtime environment for executing JavaScript code server-side. You can download it from Node.js official website.

  • npm (Node Package Manager): Comes with Node.js, but you can check if it's installed by running npm -v in your terminal. If you need to update npm, run:

    npm install npm@latest -g

Installation

To get a local copy up and running follow these simple steps.

  1. Clone the repository Begin by cloning the repository to your local machine:

    git clone https://github.com/austin-cavanagh/portfolio.git
  2. Navigate to the project directory Enter directory after cloning:

    cd portfolio
  3. Install dependencies Install the necessary packages using npm:

    npm install
  4. Start the development server To start the Vite development server run:

    npm run dev
  5. Build for production To build the project for production, use:

    npm run build

    After building, run the production build by using:

    npm start
  6. Happy coding!

(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)

Contact

Austin Cavanagh - GitHub - LinkedIn - austin.cavanagh.cs@gmail.com

(back to top)

License

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

(back to top)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published