Skip to content

Commit

Permalink
readme update for modules
Browse files Browse the repository at this point in the history
  • Loading branch information
Resul Avan authored and Resul Avan committed Jul 21, 2020
1 parent a57a86a commit e6ab06e
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,36 @@ See the [Features](#features) for more functionalities

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

```shell script
|-- functions
| |-- modules
| | |-- handlers-module
| | | `-- src
| | `-- types-module
| | `-- src
| `-- src
`-- src
|-- assets
|-- components
|-- i18n
|-- layouts
|-- middleware
|-- mixin
|-- pages
|-- plugins
|-- server
|-- service
|-- static
|-- store
|-- types
```


## DETAILED DOCUMENTATION
> Coming soon
Expand All @@ -31,6 +59,7 @@ See the [Features](#features) for more functionalities
- [x] nuxtjs - universal mode
- [x] dynamic profile page with username
- [x] typescript
- [x] local npm modules for shared types and functions
- [x] firebase
- [x] firebase-hosting
- [x] firebase-functions
Expand Down

0 comments on commit e6ab06e

Please sign in to comment.