Skip to content

Commit f4a542f

Browse files
committed
<implementation>(MENU): use of react-svg-inliner, documentation
1 parent 7ba0c74 commit f4a542f

14 files changed

Lines changed: 316 additions & 174 deletions

β€ŽLICENSEβ€Ž

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
This is free and unencumbered software released into the public domain.
2+
3+
Anyone is free to copy, modify, publish, use, compile, sell, or
4+
distribute this software, either in source code form or as a compiled
5+
binary, for any purpose, commercial or non-commercial, and by any
6+
means.
7+
8+
In jurisdictions that recognize copyright laws, the author or authors
9+
of this software dedicate any and all copyright interest in the
10+
software to the public domain. We make this dedication for the benefit
11+
of the public at large and to the detriment of our heirs and
12+
successors. We intend this dedication to be an overt act of
13+
relinquishment in perpetuity of all present and future rights to this
14+
software under copyright law.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19+
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20+
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21+
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22+
OTHER DEALINGS IN THE SOFTWARE.
23+
24+
For more information, please refer to <https://unlicense.org>

β€ŽREADME.mdβ€Ž

Lines changed: 70 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,77 @@
22

33
[![https://codejovz.vercel.app](/public/portfolioShowcase.png)](https://codejovz.vercel.app)
44

5-
Click on the photo to see the live site.
5+
Click on the photo to visit the live site.
66

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`.
776

877
<details>
978
<summary>I used React + TypeScript + Vite</summary>

0 commit comments

Comments
Β (0)