Skip to content

Add documentation on cloud function directory structure #2

@richford

Description

@richford

We should document (the upcoming changes to) the roar-firebase-functions directory structure. In order to maintain firebase functions for multiple projects, we will adopt the following structure

/
├── admin
│   ├── common
│   │   ├── common-utility-file1.ts
│   │   ├── common-utility-file2.ts
│   ├── roar
|   |   ├── firebase.json
|   |   ├── functions
|   │   │   ├── package.json
|   │   │   ├── tsconfig.json
|   │   │   ├── tsconfig.dev.json
|   │   │   ├── src
|   |   │   │   ├── index.ts
|   |   │   │   ├── project-specific-file1.ts
│   ├── levante
|   |   ├── firebase.json
|   |   ├── functions
|   │   │   ├── package.json
|   │   │   ├── tsconfig.json
|   │   │   ├── tsconfig.dev.json
|   │   │   ├── src
|   |   │   │   ├── index.ts
|   |   │   │   ├── project-specific-file1.ts
│   ├── <one additional folder for each project ID>
├── assessment
│   ├── common
│   │   ├── common-utility-file1.ts
│   │   ├── common-utility-file2.ts
│   ├── roar
|   |   ├── firebase.json
|   |   ├── functions
|   │   │   ├── package.json
|   │   │   ├── tsconfig.json
|   │   │   ├── tsconfig.dev.json
|   │   │   ├── src
|   |   │   │   ├── index.ts
|   |   │   │   ├── project-specific-file1.ts
│   ├── levante
|   |   ├── firebase.json
|   |   ├── functions
|   │   │   ├── package.json
|   │   │   ├── tsconfig.json
|   │   │   ├── tsconfig.dev.json
|   │   │   ├── src
|   |   │   │   ├── index.ts
|   |   │   │   ├── project-specific-file1.ts
│   ├── <one additional folder for each project ID>

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions