|
2 | 2 |
|
3 | 3 | [](https://codejovz.vercel.app) |
4 | 4 |
|
5 | | -Click on the photo to see the live site. |
| 5 | +Click on the photo to visit the live site. |
6 | 6 |
|
| 7 | +## β‘ Tech Stack |
| 8 | + |
| 9 | +This project leverages the latest standards in web development: |
| 10 | + |
| 11 | +* **React 19**: Built on the cutting-edge version of React. |
| 12 | +* **TypeScript**: Ensuring type safety and a robust development experience. |
| 13 | +* **CSS Modules**: For scoped, maintainable, and collision-free styling. |
| 14 | +* **Modern CSS**: Utilizing CSS variables and native features for a responsive and themable design. |
| 15 | +* **Vite**: A fast build tool for modern web development. |
| 16 | +* **[react-svg-inliner](https://github.com/codejovz/react-svg-inliner)**: A React component for inlining SVG images. |
| 17 | + |
| 18 | + |
| 19 | +## π Getting Started |
| 20 | + |
| 21 | +Follow these steps to run the documentation locally on your machine. |
| 22 | + |
| 23 | +### 1. Clone the Repository |
| 24 | + |
| 25 | +If you haven't already, clone the `codejovz.github.io` repository: |
| 26 | + |
| 27 | +```bash |
| 28 | +git clone https://github.com/codejovz/codejovz.github.io.git |
| 29 | +``` |
| 30 | + |
| 31 | +### 2. Navigate to the Project Directory |
| 32 | + |
| 33 | +Switch to the `codejovz.github.io` folder where this web application resides: |
| 34 | + |
| 35 | +```bash |
| 36 | +cd codejovz.github.io |
| 37 | +``` |
| 38 | + |
| 39 | +### 3. Install Dependencies |
| 40 | + |
| 41 | +Install the necessary dependencies using `npm`: |
| 42 | + |
| 43 | +```bash |
| 44 | +npm install |
| 45 | +``` |
| 46 | + |
| 47 | +### 4. Run the Development Server |
| 48 | + |
| 49 | +Start the local development server: |
| 50 | + |
| 51 | +```bash |
| 52 | +npm run dev |
| 53 | +``` |
| 54 | + |
| 55 | +Open [http://localhost:5173](http://localhost:5173) with your browser to see the result. |
| 56 | + |
| 57 | +## π Project Structure |
| 58 | + |
| 59 | +This project follows a **Feature-Based Architecture**. This keeps related code collocated, making it easier to maintain and scale. |
| 60 | + |
| 61 | +``` |
| 62 | +βββ public/ # Static Assets (Google, company logos) |
| 63 | +βββ src/ |
| 64 | +β βββ features/ |
| 65 | +β β βββ resumee/ # Subcomponents and utils for resumee |
| 66 | +β β βββ showcase/ # Subcomponents and utils for showcase |
| 67 | +β βββ App.tsx # Main application component |
| 68 | +β βββ App.css/ # Main application styles |
| 69 | +β βββ Menu.tsx/ # Menu component |
| 70 | +β βββ ... |
| 71 | +βββ index.html # Loads script for Google's font. |
| 72 | +βββ ... |
| 73 | +``` |
| 74 | + |
| 75 | +* **`src/`**: Contains the main application logic. Each folder represents a component (e.g., `/resumee`, `/showcase`), encompassing its own page, layout, and specific styles with `*.module.css`. |
7 | 76 |
|
8 | 77 | <details> |
9 | 78 | <summary>I used React + TypeScript + Vite</summary> |
|
0 commit comments