Skip to content

Commit 1cc79be

Browse files
committed
docs: better project documentations
1 parent f489325 commit 1cc79be

File tree

7 files changed

+108
-376
lines changed

7 files changed

+108
-376
lines changed
269 KB
Loading

public/images/projects/piml.webp

149 KB
Loading
76 KB
Loading

public/projects/fezcodex.txt

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,37 @@
1-
# Overview
1+
# Fezcodex: The Digital Sanctum
22

3-
[Development Series](/blog/series/react-of-fezcodex)
3+
![Fezcodex - Cover Art](/images/projects/fezcodex.webp)
44

5-
**Fezcodex** is a _personal website_ and _blog_, serving as a digital hub for various content, including blog posts, personal projects, and D&D-related materials. It's built with a focus on modern web technologies, aiming for a clean, responsive, and performant user experience.
5+
**Fezcodex** is more than just a portfolio; it's a living digital garden, a personal operating system, and a testament to the brutalist aesthetic of the modern web. Built with **React** and **Tailwind CSS**, it serves as the central hub for my development journey, thoughts, and experiments.
66

7-
## Key Features:
7+
> "A reflection of the developer's soul, rendered in code and pixels."
88

9-
* **Blog:** A platform for sharing articles and insights on various topics, including software development, algorithms, and personal reflections.
10-
* **Projects Showcase:** A dedicated section to display personal coding projects, complete with descriptions and links.
11-
* **D&D Content:** A space for Dungeons & Dragons related content, such as campaign logs or lore.
12-
* **Responsive Design:** Optimized for viewing across different devices and screen sizes.
13-
* **Fast and Modern UI:** Built with contemporary frontend tools to ensure a smooth and engaging user interface.
9+
## Core Philosophy
1410

15-
## Technologies Used:
11+
Fezcodex was designed to break away from the sterile, corporate look of standard portfolios. It embraces:
12+
* **Brutalism:** Raw, unpolished, and honest UI elements.
13+
* **Interactivity:** A command palette, hidden modes, and easter eggs that reward exploration.
14+
* **Performance:** Blazing fast navigation and optimized asset loading.
1615

17-
The Fezcodex project leverages a robust stack of modern web development technologies:
16+
## Key Features
1817

19-
* **React:** The core JavaScript library for building the user interface, enabling a component-based and declarative approach to UI development.
20-
* **Tailwind CSS:** A utility-first CSS framework used for rapid and consistent styling, allowing for highly customizable designs directly in the markup.
21-
* **React Router DOM:** For declarative routing within the application, managing navigation between different pages and content sections.
22-
* **Craco:** (Create React App Configuration Override) Used to extend and customize the Create React App configuration without ejecting, providing more control over the build process (e.g., integrating Tailwind CSS).
23-
* **JavaScript (ES6+):** The primary programming language for frontend logic and interactivity.
24-
* **HTML5 & CSS3:** The foundational languages for structuring and styling web content.
25-
* **Markdown:** Used for writing blog posts and other textual content, offering a simple and readable format that is easily converted to HTML.
26-
* **`@phosphor-icons/react` & `react-icons`:** Libraries for incorporating a wide range of vector icons, enhancing the visual appeal and usability of the interface.
27-
* **`framer-motion`:** A production-ready motion library for React, used for animations and interactive elements to create a more dynamic user experience.
28-
* **`marked` & `react-markdown`:** Libraries for parsing and rendering Markdown content into React components.
29-
* **`gh-pages`:** A utility to publish the `build` directory to a `gh-pages` branch on GitHub, facilitating easy deployment to GitHub Pages.
30-
* **`rss`:** A library used to generate an RSS feed for the blog, allowing users to subscribe to content updates.
31-
* **`stackblur-canvas`:** Used in specific project implementations (like the Image Toolkit) for efficient image blurring directly on the canvas.
18+
* **The Command Palette:** Navigate, toggle themes, or hack the system with a `Cmd+K` interface.
19+
* **Visual Modes:** Switch between `Cyberpunk`, `Retro`, `Terminal`, and more to match your mood.
20+
* **Dynamic Content:** Integrated blog engine with support for complex markdown, code highlighting, and live component rendering.
21+
* **Project Showcase:** Immersive deep-dives into my work (like the page you're on now).
22+
* **Digital Garden:** A space for raw notes, logs, and work-in-progress thoughts.
3223

33-
This combination of technologies allows Fezcodex to be a dynamic, maintainable, and visually appealing platform for sharing content.
24+
## Tech Stack & Architecture
25+
26+
Fezcodex is built on a modern stack designed for scalability and developer experience:
27+
28+
* **Frontend:** React (Create React App + Craco) for component-based architecture.
29+
* **Styling:** Tailwind CSS for utility-first design, augmented with custom animations via Framer Motion.
30+
* **Routing:** React Router DOM for seamless client-side navigation.
31+
* **Content:** Custom Markdown pipeline using `remark` and `rehype` for rich text processing.
32+
* **State:** React Context API for managing global themes, audio, and user preferences.
33+
34+
## Development Series
35+
36+
Interested in how this was built? Check out the development logs:
37+
[React of Fezcodex](/blog/series/react-of-fezcodex)

0 commit comments

Comments
 (0)