Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
janishar committed Jul 10, 2024
1 parent 0814d3a commit ee1bdf9
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
Binary file removed .resources/documentations/assets/api-structure.png
Binary file not shown.
4 changes: 4 additions & 0 deletions .resources/documentations/assets/request-flow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,9 @@ Using this app can bring a little bit of happiness and energy to live an inspire

The Android App using this backend is also open-sourced. You can find the project here: [Modern Android Development - WhereIsMyMotivation](https://github.com/unusualcodeorg/wimm-android-app)

## API Framework Design
![Request-Response-Design](.resources/documentations/assets/api-structure.png)

## Request-Response Flow
`
src → main.ts → app-module.ts → core.module.ts → apikey.guard.ts → auth.module.ts → auth.guard.ts → role.guard.ts → [feature].module.ts → [feature].controller.ts → [feature].service.ts → response.validation.ts → exception.handler.ts → response.transformer.ts
`

![Request-Response-Design](.resources/documentations/assets/request-flow.svg)

# Installation Instruction
vscode is the recommended editor - dark theme
Expand Down

0 comments on commit ee1bdf9

Please sign in to comment.