Json026 commited on
Commit
8028ac7
Β·
verified Β·
1 Parent(s): b0b1af5

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +62 -19
README.md CHANGED
@@ -1,33 +1,60 @@
1
  # DSA Portfolio
2
 
3
- A modern personal DSA knowledge repository.
4
 
5
- ## Features
 
 
6
 
7
  - Dynamic JSON-based problem listing
8
- - Search & filtering
9
- - Beautiful glassmorphism UI
10
- - Dedicated explanation page for every problem
11
- - Responsive design
12
- - Tailwind CSS
13
- - Vanilla JavaScript
14
 
15
- ## Folder Structure
 
 
16
 
17
  ```bash
18
  dsa-portfolio/
19
  β”‚
20
  β”œβ”€β”€ index.html
21
  β”œβ”€β”€ data.json
 
 
22
  β”œβ”€β”€ assets/
 
 
23
  β”œβ”€β”€ problems/
24
- └── README.md
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
25
  ```
26
 
27
- ## Adding New Problems
28
 
29
- 1. Create a new HTML file inside `problems/`
30
- 2. Add entry in `data.json`
 
31
 
32
  Example:
33
 
@@ -43,15 +70,31 @@ Example:
43
  }
44
  ```
45
 
46
- ## Run Locally
 
 
 
 
47
 
48
- Open with Live Server in VS Code.
49
 
50
- ## Future Improvements
 
 
 
 
51
 
52
  - Streak calendar
53
  - Topic analytics
54
  - Dark/light mode persistence
55
- - Code syntax highlighting
56
- - Notes markdown support
57
- - GitHub API integration
 
 
 
 
 
 
 
 
 
1
  # DSA Portfolio
2
 
3
+ A modern personal DSA knowledge repository for documenting solved Data Structures & Algorithms problems.
4
 
5
+ ---
6
+
7
+ # Features
8
 
9
  - Dynamic JSON-based problem listing
10
+ - Search functionality
11
+ - Filter by topic/difficulty
12
+ - Dedicated explanation page for each problem
13
+ - Glassmorphism modern UI
14
+ - Fully responsive
15
+ - Tailwind CSS + Vanilla JavaScript
16
 
17
+ ---
18
+
19
+ # Folder Structure
20
 
21
  ```bash
22
  dsa-portfolio/
23
  β”‚
24
  β”œβ”€β”€ index.html
25
  β”œβ”€β”€ data.json
26
+ β”œβ”€β”€ README.md
27
+ β”‚
28
  β”œβ”€β”€ assets/
29
+ β”‚ └── style.css
30
+ β”‚
31
  β”œβ”€β”€ problems/
32
+ β”‚ └── subsets.html
33
+ ```
34
+
35
+ ---
36
+
37
+ # Adding New Problems
38
+
39
+ ## Step 1
40
+
41
+ Create a new HTML file inside:
42
+
43
+ ```bash
44
+ /problems/
45
+ ```
46
+
47
+ Example:
48
+
49
+ ```bash
50
+ /problems/two-sum.html
51
  ```
52
 
53
+ ---
54
 
55
+ ## Step 2
56
+
57
+ Add a new object in `data.json`
58
 
59
  Example:
60
 
 
70
  }
71
  ```
72
 
73
+ ---
74
+
75
+ # Run Locally
76
+
77
+ Use VS Code Live Server extension.
78
 
79
+ OR
80
 
81
+ Simply open `index.html`.
82
+
83
+ ---
84
+
85
+ # Future Improvements
86
 
87
  - Streak calendar
88
  - Topic analytics
89
  - Dark/light mode persistence
90
+ - Syntax highlighting
91
+ - Markdown notes support
92
+ - GitHub integration
93
+
94
+ ---
95
+
96
+ # Tech Stack
97
+
98
+ - HTML5
99
+ - Tailwind CSS
100
+ - Vanilla JavaScript