Add local run instructions

This commit is contained in:
2026-01-27 02:20:16 +00:00
parent 3410b6c64b
commit e49a4a4512

View File

@@ -1,56 +1,92 @@
# Donovan Kelly - Portfolio # Donovan Kelly - Portfolio
A clean, responsive portfolio site. A clean, responsive portfolio website.
## Quick Start (Local)
### Option 1: Python (quickest)
```bash
cd donovan-portfolio
python3 -m http.server 8080
# Open http://localhost:8080
```
### Option 2: Node.js
```bash
npx serve .
# or
npx http-server -p 8080
```
### Option 3: Docker
```bash
docker build -t donovan-portfolio .
docker run -p 8080:80 donovan-portfolio
# Open http://localhost:8080
```
## Structure ## Structure
``` ```
donovan-portfolio/ donovan-portfolio/
├── index.html ├── index.html # Main page
├── css/ ├── css/
│ └── style.css │ └── style.css # Styles (edit colors in :root)
├── js/ ├── js/
│ └── main.js │ └── main.js # Smooth scroll, nav effects
├── assets/ ├── assets/ # Images, favicon (add yours)
│ └── (images, favicon, etc.) ├── Dockerfile # For container deployment
└── README.md └── README.md
``` ```
## Setup ## Setup
### Contact Form ### Contact Form
The contact form uses [Formspree](https://formspree.io/) for handling submissions on static hosting. Uses [Formspree](https://formspree.io/) for static hosting compatibility.
1. Create a free account at formspree.io 1. Create a free account at formspree.io
2. Create a new form and copy the form ID 2. Create a new form and copy the form ID
3. Replace `YOUR_FORM_ID` in `index.html` with your actual form ID: 3. Replace `YOUR_FORM_ID` in `index.html`:
```html ```html
<form action="https://formspree.io/f/YOUR_FORM_ID" method="POST"> <form action="https://formspree.io/f/YOUR_FORM_ID" method="POST">
``` ```
### Social Links ### Social Links
Update the GitHub link in `index.html` if you have one: Update the GitHub link in `index.html` with your username:
```html ```html
<a href="https://github.com/YOUR_USERNAME" ...> <a href="https://github.com/YOUR_USERNAME" ...>
``` ```
## Deployment
### Static Hosting (Netlify, Vercel, GitHub Pages)
Just upload/push the folder - no build step required.
### Docker
```dockerfile
FROM nginx:alpine
COPY . /usr/share/nginx/html
EXPOSE 80
```
### Dokploy
Upload as static site or use the Docker method above.
## Customization ## Customization
- **Colors**: Edit CSS variables in `css/style.css` under `:root` ### Colors
- **Content**: Edit `index.html` directly Edit CSS variables in `css/style.css` under `:root`:
- **Add projects**: Copy a `.project-card` block and modify ```css
:root {
--color-primary: #2563eb; /* Accent color */
--color-bg: #fafafa; /* Background */
--color-text: #1a1a1a; /* Text */
/* ... */
}
```
### Content
Edit `index.html` directly:
- Hero section: name, title, description
- About: bio, skills tags
- Projects: copy a `.project-card` block to add more
## Deployment
### Dokploy
Use the Dockerfile - deploy as a container.
### Static Hosting (Netlify, Vercel, GitHub Pages)
Just push/upload - no build step needed.
### Manual
Copy files to any web server's document root.
---
Built with ❤️ by Hammer