diff --git a/README.md b/README.md index 36ceab6..00c8ada 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,37 @@ -# My Portfolio – Express × Vite × Tailwind +# Ryan Hopkins · Portfolio -## Vist at [https://proco-rphopkins.github.io/Portfolio/](https://proco-rphopkins.github.io/Portfolio/) +### 🌐 Live site: [https://proco-rphopkins.github.io/Portfolio/](https://proco-rphopkins.github.io/Portfolio/) -A quick two-tier test app you can run entirely in Google Cloud Shell (or any Node 18+ setup). +A modern portfolio built with Vite + TailwindCSS. +--- + +## 🚀 Prerequisites + +Node.js ≥ 18 +npm --- -## Prerequisites -* Node.js ≥ 18 installed (Cloud Shell already has it) -* At least two terminal tabs (three is more comfortable) +## 🛠️ Tech Stack + +* Vite – modern frontend tooling +* Tailwind CSS – styling & utility classes +* Particles.js – animated background +* Custom assets – icons, images --- -## 1 Backend API (Express) - -```bash -cd gcs-demo/backend -npm install # first time only -npm run dev # starts Express at http://localhost:4000 -``` - -## 2 Tailwind CLI watcher (CSS build) -### open a second terminal -cd gcs-demo/frontend -npm run build:css # keeps watching; writes src/output.css on every save -# add "&" to run it in the background if you prefer: -# npm run build:css & - - -## 3 Front-end (Vite) -# same terminal as step 2 or a third one -cd gcs-demo/frontend -npm run dev # serves the UI at http://localhost:5173 - -## | Port | Purpose | How to open in Cloud Shell | -| ---- | -------------- | ------------------------------------- | -| 4000 | Express API | Web Preview ▸ **Change port…** ▸ 4000 | -| 5173 | Vite front-end | Web Preview ▸ **Change port…** ▸ 5173 | - -## One-liner (optional) -### If you have the concurrently package installed, you can launch everything at once: -npm i -g concurrently -concurrently -c green,cyan,magenta \ - "cd gcs-demo/backend && npm run dev" \ - "cd gcs-demo/frontend && npm run build:css" \ - "cd gcs-demo/frontend && npm run dev" +## ▶️ Running this Project + +1. `cd Portfolio/frontend` +2. `npm install` +3. `npm run dev` + +--- + +## 🌍 Deployment + +This site is automatically deployed to GitHub Pages using GitHub Actions: +* `.github/workflows/deploy.yml` handles builds & publishing. +* `.nojekyll` ensures Pages serves files correctly without Jekyll interference. +Any push to `main` triggers a new deployment.