Skip to content

Commit e6ab06e

Browse files
Resul AvanResul Avan
authored andcommitted
readme update for modules
1 parent a57a86a commit e6ab06e

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,36 @@ See the [Features](#features) for more functionalities
2121

2222
- [functions](./functions): source folder for firebase-functions
2323
- [modules](./functions/modules): Shared types and functions between front-end and back-end (firebase-functions and nuxt serverMiddleware)
24+
- [types-module](./functions/modules/types-module): has all shared types (enums, interfaces, constants)
25+
- [handlers-module](./functions/modules/handlers-module): has all express handlers. Also, has all backend services like firebase-admin and firestore
26+
- src: the source of the functions
2427
- [src](./src): nuxt application
2528

29+
```shell script
30+
|-- functions
31+
| |-- modules
32+
| | |-- handlers-module
33+
| | | `-- src
34+
| | `-- types-module
35+
| | `-- src
36+
| `-- src
37+
`-- src
38+
|-- assets
39+
|-- components
40+
|-- i18n
41+
|-- layouts
42+
|-- middleware
43+
|-- mixin
44+
|-- pages
45+
|-- plugins
46+
|-- server
47+
|-- service
48+
|-- static
49+
|-- store
50+
|-- types
51+
52+
```
53+
2654

2755
## DETAILED DOCUMENTATION
2856
> Coming soon
@@ -31,6 +59,7 @@ See the [Features](#features) for more functionalities
3159
- [x] nuxtjs - universal mode
3260
- [x] dynamic profile page with username
3361
- [x] typescript
62+
- [x] local npm modules for shared types and functions
3463
- [x] firebase
3564
- [x] firebase-hosting
3665
- [x] firebase-functions

0 commit comments

Comments
 (0)