@@ -9,30 +9,39 @@ Static portfolio website (HTML/CSS/JS) showcasing production-minded **ML** & **G
99## Local run
1010
1111### Option A (recommended): Python
12+
13+ From the repo root:
14+
1215``` bash
1316python -m http.server 8000
1417```
1518
16- Then open:
19+ Open:
20+
1721- http://localhost:8000
1822
1923### Option B: Node tooling (optional)
24+
2025Install dev tooling:
26+
2127``` bash
2228npm install
2329```
2430
2531Lint:
32+
2633``` bash
2734npm run lint
2835```
2936
3037Format:
38+
3139``` bash
3240npm run format
3341```
3442
3543Serve locally:
44+
3645``` bash
3746npm run start
3847```
@@ -49,6 +58,7 @@ This repository is configured as a **User GitHub Pages site**:
49584 . ** Folder:** ` /(root) `
5059
5160The site is served at:
61+
5262- https://tarekmasryo.github.io/
5363
5464---
@@ -57,7 +67,7 @@ The site is served at:
5767
5868- ` index.html ` — main page
5969- ` styles.css ` — styling
60- - ` app.js ` — client-side logic (use ` type="module" ` in HTML if using ` import/export ` )
70+ - ` app.js ` — client-side logic
6171- ` assets/ ` — images + icons (** must be committed** )
6272- ` site.webmanifest ` — PWA metadata + app icons
6373- ` robots.txt ` — crawler rules
@@ -67,13 +77,19 @@ The site is served at:
6777
6878## Notes
6979
70- - Do ** not** add ` assets/ ` to ` .gitignore ` (otherwise icons/images won’t load on Pages).
71- - If you use ` import/export ` in ` app.js ` , ensure the script tag is:
80+ - ** GitHub Pages is case-sensitive** : ` Image.png ` ≠ ` image.png ` (same for spaces and extensions).
81+ - Do ** not** add ` assets/ ` to ` .gitignore ` (otherwise images won’t load on Pages).
82+ - If you use ES modules (` import/export ` ) in ` app.js ` , update the script tag to:
83+
7284 ``` html
7385 <script type =" module" src =" app.js" ></script >
7486 ```
7587
88+ - If updates don’t appear immediately, hard refresh (Ctrl+F5) or bump the ` ?v= ` cache-buster in asset URLs.
89+ - Optional: add an empty ` .nojekyll ` file in the repo root to disable Jekyll processing.
90+
7691---
7792
7893## License
94+
7995MIT — see ` LICENSE ` .
0 commit comments