Skip to content

Commit 86f3063

Browse files
authored
Merge pull request #609 from farah21109/main
Add Complete Project Structure to README
2 parents 789ed35 + bdd2121 commit 86f3063

File tree

1 file changed

+94
-0
lines changed

1 file changed

+94
-0
lines changed

docs/README.md

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,100 @@ A clean, minimal, and static web-based tool built using **HTML, CSS, and JavaScr
6565
- Python
6666

6767
----
68+
## 📂 Project Structure
69+
70+
71+
```
72+
📦 Research-Paper-Organizer
73+
├── 📂 .github/ # GitHub workflows, issue & PR templates
74+
├── 📂 .vscode/ # VS Code workspace settings
75+
├── 📂 backend/ # Backend code
76+
│ ├── 📂 src/
77+
│ │ ├── 📂 config/ # Configuration files
78+
│ │ ├── 📂 controllers/ # Business logic
79+
│ │ ├── 📂 middleware/ # Middleware functions
80+
│ │ ├── 📂 models/ # Database models
81+
│ │ ├── 📂 routes/ # API routes
82+
│ │ ├── 📂 utils/ # Helper utilities
83+
│ │ └── 📜 app.js # App entry point
84+
│ │
85+
│ ├── 📜 .env.example # Example environment variables
86+
│ ├── 📜 .gitignore # Git ignore rules
87+
│ ├── 📜 package-lock.json # Dependency lockfile
88+
│ ├── 📜 package.json # Backend dependencies & scripts
89+
│ └── 📜 test-env.js # Environment test script
90+
91+
├── 📂 css/ # Stylesheets
92+
│ ├── 📜 Tag-Based-filtering.css
93+
│ ├── 📜 about.css
94+
│ ├── 📜 add-organize-papers.css
95+
│ ├── 📜 ats-checker.css
96+
│ ├── 📜 auth.css
97+
│ ├── 📜 blog.css
98+
│ ├── 📜 contact.css
99+
│ ├── 📜 faq.css
100+
│ ├── 📜 forgot-password.css
101+
│ ├── 📜 glossary.css
102+
│ ├── 📜 hemingway.css
103+
│ ├── 📜 open-source.css
104+
│ ├── 📜 pdf-annotator.css
105+
│ ├── 📜 pdf-viewer.css
106+
│ ├── 📜 profile-settings.css
107+
│ ├── 📜 style.css
108+
│ ├── 📜 summarize.css
109+
│ └── 📜 tool.css
110+
111+
├── 📂 docs/ # Documentation files
112+
├── 📂 favicon/ # Favicon & PWA assets
113+
├── 📂 images/ # Image assets
114+
├── 📂 js/ # JavaScript files
115+
116+
├── 📜 .gitignore
117+
├── 📜 Faq.html
118+
├── 📜 License
119+
├── 📜 Masthead.html
120+
├── 📜 Pdfconverter.html
121+
├── 📜 Research_Paper_Summary.py
122+
├── 📜 TODO.md
123+
├── 📜 Tag-Based-filtering.html
124+
├── 📜 about.html
125+
├── 📜 about_new.html
126+
├── 📜 add-organize-papers.html
127+
├── 📜 app.js
128+
├── 📜 ats-checker.html
129+
├── 📜 auth-callback.html
130+
├── 📜 blog.html
131+
├── 📜 contact.html
132+
├── 📜 forgot-password.html
133+
├── 📜 glossary.html
134+
├── 📜 hemingway.html
135+
├── 📜 home.html
136+
├── 📜 index.html
137+
├── 📜 landing.css
138+
├── 📜 landing.js
139+
├── 📜 login.html
140+
├── 📜 manage.py
141+
├── 📜 offline.html
142+
├── 📜 open-source.html
143+
├── 📜 package.json
144+
├── 📜 pdf-annotator.html
145+
├── 📜 pdf-viewer.html
146+
├── 📜 privacy.html
147+
├── 📜 profile-settings.html
148+
├── 📜 profile.html
149+
├── 📜 roadmap.html
150+
├── 📜 signup.html
151+
├── 📜 site.webmanifest
152+
├── 📜 slider.css
153+
├── 📜 summarize.html
154+
├── 📜 terms-of-service.html
155+
├── 🖼️ test1.jpg
156+
├── 🖼️ testimonialw.png
157+
└── 📜 tools.html
158+
159+
```
160+
161+
68162

69163

70164

0 commit comments

Comments
 (0)