NowPower Design

This repository contains the specifications and designs for our app

Structure

.
├── flows       # Contains MD files with user flows
│   ├── TEMPLATE.md  # Contains a template of user flows
│   ├── README.md    # Contains the specification of user flows
│   └── ...
├── design      # Contains MD files with app designs
│   ├── TEMPLATE.md  # Contains a template of screen designs
│   ├── README.md    # Contains the specification of screen designs 
│   └── ...
├── api         # Contains YAML files of OpenAPI data 
│   ├── README.md   
│   ├── openapi.yaml        # The root OpenAPI document which imports all other YAML documents
│   ├── paths               # Each YAML file in a subdirectory corresponds to the definition of a specific API endpoint path
│   │   └── ...
│   └── schema              # Each YAML file consists of a reusable OpenAPI schema model (e.g. a User model)
│       ├── components            # Contains the building block models (users, etc.)
│       │   └── ...
│       ├── errors                # Contains the models for error responses
│       │   └── ...
│       ├── requests              # Contains the models for request bodies
│       │   └── ...
│       └── responses             # Contains the models for successful response bodies
│           └── ...
└── infra       # Contains MD files which describe an aspect of the future infrastructure deployment
    ├── README.md    # Contains the infrastructure specifications
    └── ...

The repository consists of 4 subdirectories, each describing a facet of the app’s design

• The flows/ directory consists of the user flows which describe the usage of a certain aspect of the app. Progress can be viewed here
• The design/ directory contains the designs of crucial views and screens.
• The api/ directory contains the OpenAPI documents which store the interface details between the frontend and backend. Progress can be viewed here
• The infra/ directory consists of future deployment and infrastructure plans.