|
| 1 | +# the quantumbagel developer portfolio |
| 2 | + |
| 3 | +Welcome to the repository for my personal portfolio website, hosted at [quantumbagel.github.io](https://quantumbagel.github.io). This is version 2 of my site, rebuilt from the ground up to be more dynamic, modern, and easily maintainable. |
| 4 | + |
| 5 | +## Overview |
| 6 | + |
| 7 | +This website serves as a showcase for my software development projects, experience, and skills. It is designed to be a clean, professional, and dark-mode-ready single-page application. |
| 8 | + |
| 9 | +## Tools: |
| 10 | + |
| 11 | +- **Frontend:** |
| 12 | + - [Tailwind CSS](https://tailwindcss.com/) for styling and layout. |
| 13 | + - [Ionicons](https://ionicons.com/) for clean, vector-based iconography. |
| 14 | + - [Inter Font](https://rsms.me/inter/) for modern typography. |
| 15 | + - [Python](https://www.python.org/) script to manage content and generate the static site. |
| 16 | + - `htmlmin` for production-ready HTML minification. |
| 17 | + - [GitHub Pages](https://pages.github.com/) for seamless deployment. |
| 18 | + |
| 19 | +## cool things it dodes |
| 20 | + |
| 21 | +- Automatically detects user preferences and provides a polished dark experience. |
| 22 | +- Interactive filtering for different categories (Discord Bots, Internships, etc.) and project-specific modals for more detail. |
| 23 | +- Fully responsive layout that looks okayish on mobile devices. |
| 24 | +- Content is decoupled from the layout, allowing for quick updates by editing a single Python file. (and honestly its pretty fun to code in python) |
| 25 | + |
| 26 | +## Project Structure |
| 27 | + |
| 28 | +- `generator.py`: The core of the project. All portfolio data (projects, skills, experience) is defined here. When run, it injects this data into an HTML template and outputs a minified `index.html`. |
| 29 | +- `index.html`: The final, minified production file used by GitHub Pages. |
| 30 | +- `tailwind.js`: tailwind library file |
| 31 | +- `font.css`: The fonts |
| 32 | +- `pfp.webp`: Profile picture |
| 33 | + |
| 34 | +## If you want to use this |
| 35 | + |
| 36 | +To update the website or run it locally: |
| 37 | + |
| 38 | +### Prerequisites |
| 39 | +Ensure you have Python installed. You will also need the `htmlmin` library: |
| 40 | +```bash |
| 41 | +pip install htmlmin |
| 42 | +``` |
| 43 | + |
| 44 | +### Updating Content |
| 45 | +Open `generator.py` and modify the data structures at the top of the file (e.g., `PERSONAL_INFO`, `ABOUT_ME`, `PROJECTS`). |
| 46 | + |
| 47 | +### Rebuilding the Site |
| 48 | +Run the generator script to apply your changes and rebuild the minified `index.html`: |
| 49 | +```bash |
| 50 | +python generator.py |
| 51 | +``` |
| 52 | + |
| 53 | +*note that even though it is forked from vcard, that was v1 and this is completely original code* |
0 commit comments