Skip to content

Commit a9cacfa

Browse files
authored
Update README.md
1 parent a0acff7 commit a9cacfa

File tree

1 file changed

+112
-0
lines changed

1 file changed

+112
-0
lines changed

README.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,118 @@ Following are the features of this project:
8585
* [Backend System Design for Startups](https://www.youtube.com/playlist?list=PLqOiaH9id5quh5Dph5yuXfdHVGe1LrKvT)
8686
* [Practical Javascript for Beginners](https://www.youtube.com/playlist?list=PLqOiaH9id5qtw5MhI-C1G3CS7RVZ8ejct)
8787

88+
## Project Directory Structure
89+
```
90+
├── src
91+
│ ├── server.ts
92+
│ ├── app.ts
93+
│ ├── config.ts
94+
│ ├── auth
95+
│ │ ├── apikey.ts
96+
│ │ ├── authUtils.ts
97+
│ │ ├── authentication.ts
98+
│ │ ├── authorization.ts
99+
│ │ └── schema.ts
100+
│ ├── core
101+
│ │ ├── ApiError.ts
102+
│ │ ├── ApiResponse.ts
103+
│ │ ├── JWT.ts
104+
│ │ └── Logger.ts
105+
│ ├── database
106+
│ │ ├── index.ts
107+
│ │ ├── model
108+
│ │ │ ├── ApiKey.ts
109+
│ │ │ ├── Blog.ts
110+
│ │ │ ├── Keystore.ts
111+
│ │ │ ├── Role.ts
112+
│ │ │ └── User.ts
113+
│ │ └── repository
114+
│ │ ├── ApiKeyRepo.ts
115+
│ │ ├── BlogRepo.ts
116+
│ │ ├── KeystoreRepo.ts
117+
│ │ ├── RoleRepo.ts
118+
│ │ └── UserRepo.ts
119+
│ ├── helpers
120+
│ │ ├── asyncHandler.ts
121+
│ │ ├── role.ts
122+
│ │ └── validator.ts
123+
│ ├── routes
124+
│ │ └── v1
125+
│ │ ├── access
126+
│ │ │ ├── login.ts
127+
│ │ │ ├── logout.ts
128+
│ │ │ ├── schema.ts
129+
│ │ │ ├── signup.ts
130+
│ │ │ └── token.ts
131+
│ │ ├── blog
132+
│ │ │ ├── blogDetail.ts
133+
│ │ │ ├── blogList.ts
134+
│ │ │ ├── editor.ts
135+
│ │ │ ├── schema.ts
136+
│ │ │ └── writer.ts
137+
│ │ ├── index.ts
138+
│ │ └── profile
139+
│ │ ├── schema.ts
140+
│ │ └── user.ts
141+
│ └── types
142+
│ └── app-request.d.ts
143+
├── tests
144+
│ ├── auth
145+
│ │ ├── apikey
146+
│ │ │ ├── mock.ts
147+
│ │ │ └── unit.test.ts
148+
│ │ ├── authUtils
149+
│ │ │ ├── mock.ts
150+
│ │ │ └── unit.test.ts
151+
│ │ ├── authentication
152+
│ │ │ ├── mock.ts
153+
│ │ │ └── unit.test.ts
154+
│ │ └── authorization
155+
│ │ ├── mock.ts
156+
│ │ └── unit.test.ts
157+
│ ├── core
158+
│ │ └── jwt
159+
│ │ ├── mock.ts
160+
│ │ └── unit.test.ts
161+
│ ├── routes
162+
│ │ └── v1
163+
│ │ ├── blog
164+
│ │ │ ├── blogDetail
165+
│ │ │ │ ├── mock.ts
166+
│ │ │ │ └── unit.test.ts
167+
│ │ │ └── writer
168+
│ │ │ ├── mock.ts
169+
│ │ │ └── unit.test.ts
170+
│ │ ├── login
171+
│ │ │ ├── integration.test.ts
172+
│ │ │ ├── mock.ts
173+
│ │ │ └── unit.test.ts
174+
│ │ └── signup
175+
│ │ ├── mock.ts
176+
│ │ └── unit.test.ts
177+
│ ├── .env.test
178+
│ └── setup.ts
179+
├── addons
180+
│ └── init-mongo.js
181+
├── keys
182+
│ ├── private.pem
183+
│ └── public.pem
184+
├── .env
185+
├── .gitignore
186+
├── .dockerignore
187+
├── .vscode
188+
│ └── launch.json
189+
├── Dockerfile
190+
├── docker-compose.yml
191+
├── package-lock.json
192+
├── package.json
193+
├── jest.config.js
194+
├── tsconfig.json
195+
└── tslint.json
196+
```
197+
198+
## Directory Traversal for Signup API call
199+
`/src → server.ts → app.ts → /routes/v1/index.ts → /auth/apikey.ts → schema.ts → /helpers/validator.ts → asyncHandler.ts → /routes/v1/signup.ts → schema.ts → /helpers/validator.ts → asyncHandler.ts → /database/repository/UserRepo.ts → /database/model/User.ts → /core/ApiResponses.ts`
88200

89201
## API Examples
90202
* Signup

0 commit comments

Comments
 (0)