Skip to content

Commit 39b44ba

Browse files
authored
Update README.md
1 parent 5342269 commit 39b44ba

1 file changed

Lines changed: 60 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,60 @@
1-
# Ronan-R-R.github.io
1+
# Portfolio Website - Ronan Roberts
2+
3+
A responsive, professional portfolio website designed to showcase software engineering projects, technical skills, and professional experience. The site features a modern dark-themed UI and is built for deployment on GitHub Pages.
4+
5+
## Live Demo
6+
7+
https://ronan-r-r.github.io
8+
9+
## Features
10+
11+
- **Responsive Design:** Fully adaptive layout that works on mobile, tablet, and desktop devices.
12+
- **Modern UI:** Dark mode aesthetic using CSS variables for consistent theming.
13+
- **Project Showcase:** Grid layout to display featured projects with technology tags.
14+
- **Experience Timeline:** Vertical timeline displaying career history and education.
15+
- **Functional Contact Form:** Integrated with FormSubmit.co for serverless email handling via AJAX.
16+
- **Smooth Navigation:** Sticky header with smooth scrolling to section anchors.
17+
18+
## Technologies Used
19+
20+
- **HTML5:** Semantic markup structure.
21+
- **CSS3:** Flexbox, CSS Grid, Media Queries, and CSS Variables.
22+
- **JavaScript:** DOM manipulation, Mobile Menu toggling, and Fetch API for the contact form.
23+
- **Font Awesome:** Iconography.
24+
- **Google Fonts:** Typography (Inter font family).
25+
26+
## Installation and Local Setup
27+
28+
1. Clone the repository:
29+
git clone https://github.com/Ronan-R-R/Ronan-R-R.github.io.git
30+
31+
2. Navigate to the project directory:
32+
cd Ronan-R-R.github.io
33+
34+
3. Open the index.html file in your preferred web browser to view the site locally.
35+
36+
## Configuration
37+
38+
### Contact Form
39+
The contact form uses FormSubmit.co to send emails without a backend server.
40+
41+
1. In index.html, the fetch URL is set to: https://formsubmit.co
42+
2. When the first submission occurs, FormSubmit will send an activation email to the address specified.
43+
3. You must click "Activate" in that email for the form to start forwarding messages to your inbox.
44+
45+
### Icons
46+
The site uses Font Awesome CDN. If icons do not load, ensure you have an active internet connection or update the CDN link in the head tag.
47+
48+
## Deployment
49+
50+
This project is designed to be hosted on GitHub Pages.
51+
52+
1. Push the index.html file to your repository (main branch).
53+
2. Go to Repository Settings > Pages.
54+
3. Under "Build and deployment", select "Deploy from a branch".
55+
4. Select "main" as the branch and "/" as the folder.
56+
5. Click Save.
57+
58+
## License
59+
60+
This project is open source and available for personal use and modification.

0 commit comments

Comments
 (0)