Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/leoplureodon/brian-dev

Repo for my portfolio website
https://github.com/leoplureodon/brian-dev

frontend html js mui mui-material nodejs npm portfolio portfolio-website react reactjs responsive ts typescript

Last synced: about 1 month ago
JSON representation

Repo for my portfolio website

Awesome Lists containing this project

README

        

# Brian O'Rourke's Portfolio

Welcome to the source code for my portfolio, available at [brianorourke.ie](https://www.brianorourke.ie/). This is a modern React-based site built with TypeScript and Material UI, designed to showcase my skills, projects, and professional background.

## Key Features

- **React and TypeScript**: Built with a focus on maintainability and type safety using React 18 and TypeScript.
- **Material UI (MUI)**: Utilizes Material UI components for responsive and accessible design, with Notistack for toast notifications.
- **Vite**: Blazing fast development experience with Vite.
- **Private C# Backend**: A private C# backend handles serving my CV as a downloadable PDF, ensuring that bots can’t easily access it.
- **Contact Form with Web3forms**: Secure contact form integrated with Web3forms for handling form submissions.
- **GitHub Pages Hosting**: The site is hosted on GitHub Pages for easy deployment and accessibility.

## Installation

To run the project locally:

1. Clone this repository:

```bash
git clone https://github.com/Leoplureodon/brian-dev.git
```

2. Install the dependencies:

```bash
npm install
```

3. Start the development server:
```bash
npm run dev
```

The site will be available at `http://localhost:5173`.

## Deployment

The portfolio is automatically deployed to GitHub Pages on each push to the `main` branch. Visit the live site at [brianorourke.ie](https://www.brianorourke.ie/).

## Technologies Used

- **React**
- **TypeScript**
- **Material UI**
- **Vite**
- **Axios**
- **Notistack**
- **React Icons**
- **Web3forms**
- **GitHub Pages**

## License

This project is licensed under the MIT License.