|
1 | | -# marcopisco.com |
2 | | - |
3 | | - |
4 | | - |
| 1 | +# Marco Pisco Website |
5 | 2 |
|
6 | | - |
| 3 | +Personal website source for [marcopisco.com](https://marcopisco.com), built with TypeScript + Vite and deployed with GitHub Pages. |
7 | 4 |
|
8 | | -My personal website's code. |
| 5 | + |
| 6 | + |
| 7 | + |
9 | 8 |
|
10 | | -## Table of Contents |
11 | | -On the root of this repository there are 3 files. The site itself, the README you're reading, and the pointless license (because nobody will ever actually use this other than myself). |
| 9 | +## Tech Stack |
12 | 10 |
|
13 | | -## License |
14 | | -This repository and work are licensed under the **GNU General Public License v3.0**. You can read the license and research about it. |
| 11 | +- TypeScript |
| 12 | +- Vite |
| 13 | +- Vanilla HTML/CSS |
| 14 | +- GitHub Actions + GitHub Pages |
| 15 | +- Lanyard WebSocket API (Discord live presence) |
| 16 | + |
| 17 | +## Features |
| 18 | + |
| 19 | +- Single-page portfolio layout (hero, about, tech stack, experience, education, contact) |
| 20 | +- Live Discord presence cards using Lanyard WebSocket |
| 21 | +- Posts section backed by local Markdown files |
| 22 | +- Smooth reveal and hover animations |
| 23 | +- Responsive layout for desktop and mobile |
| 24 | + |
| 25 | +## Local Development |
| 26 | + |
| 27 | +```bash |
| 28 | +npm install |
| 29 | +npm run dev |
| 30 | +``` |
| 31 | + |
| 32 | +Default dev URL: `http://localhost:5173` |
| 33 | + |
| 34 | +## Build and Preview |
| 35 | + |
| 36 | +```bash |
| 37 | +npm run build |
| 38 | +npm run preview |
| 39 | +``` |
| 40 | + |
| 41 | +The production build is generated in `dist/`. |
| 42 | + |
| 43 | +## Posts Workflow |
15 | 44 |
|
16 | | -## Warranty |
17 | | -This website will be updated whenever I need it updated, and whenever I feel like it. There isn't a schedule of updates for it. |
| 45 | +Posts are loaded from the `public/writeups` directory: |
| 46 | + |
| 47 | +- `public/writeups/index.json` contains metadata for each post |
| 48 | +- `public/writeups/<slug>.md` contains the Markdown content |
| 49 | + |
| 50 | +Example `index.json` item: |
| 51 | + |
| 52 | +```json |
| 53 | +{ |
| 54 | + "slug": "example-post", |
| 55 | + "title": "Example Post", |
| 56 | + "date": "2026-01-15", |
| 57 | + "summary": "Short summary.", |
| 58 | + "tags": ["tag1", "tag2"] |
| 59 | +} |
| 60 | +``` |
| 61 | + |
| 62 | +## Deployment |
| 63 | + |
| 64 | +Deployment is fully automated by [`.github/workflows/deploy-pages.yml`](.github/workflows/deploy-pages.yml): |
| 65 | + |
| 66 | +1. Trigger on push to `main` |
| 67 | +2. Install dependencies with `npm ci` |
| 68 | +3. Build with `npm run build` |
| 69 | +4. Upload `dist/` artifact |
| 70 | +5. Deploy to GitHub Pages |
| 71 | + |
| 72 | +Custom domain is configured via `CNAME` (`marcopisco.com`). |
| 73 | + |
| 74 | +## License |
18 | 75 |
|
19 | | -## Credits |
20 | | -Nobody else other than me worked on this project. Have an idea or a better way to do what I did? Great, make a pull request and I might approve it. |
| 76 | +This project is licensed under the GNU General Public License v3.0. See [LICENSE](LICENSE). |
0 commit comments