City Details

Add a short description

| Task | Alpha Branch | Chat | Alpha | Beta | Production

note

This document is not meant to outline how to use the API endpoints, rather how to build it. We outline what it's capabilities should be, once you have built them, you can creat documentation on how to utilize them on the APIs tab.

---

Status & Details

Description

Add a detailed description

Status

warning

These details are only updated with each release, for more acurate updates and keeping track of progress, see the task in GitHub.

Owner	Lead	Doc Status	Product Status	Last Update	Version	Release	Phase
-	-	In Progress	Up Next	04.03.2024	0.01	Internal	Alpha

Reminders

• Keep code lean and clear
• follow the outlined arcetecture
• write commetes in your code
• update the staus in the docs and in GitHub
• try not to recreate functions we alredy have, rather update exsiting functions to support your needs
• Be sure to follow the release guidelines
• Update Documentation
• keep API docs up to date each time you update or add endpoints

Links & Resources

Coming Soon

• Biz Docs
• Research
• Design
• Prototype
• Dev Mode
• Task
• Alpha Branch
• Chat
• Alpha
• Beta
• Production

User Stories, Flows & Personas

User Stories

Persona One

Update Coming Soon

As a busy user I don’t want to watch but rather listen to a podcast, however, when I hear a voice I don’t recognize, I want to take a glance at my phone to see a name and/or photo of who is talking or maybe ask the built-in “AI/assistant”.

User Flows

Personas

Features & Functions

Features

Below is a list of features that will be utilized in order to deliver the best account features and functionalities. The details bellow are not comprehensive feature details but rather, describe how the features will be utilized within the account, for further details, please see the individual feature documentation.

• [Authentication]

  • [Social Auth]

  • [Number Auth]

  • [Passkey]

  • [Email]

  • [2FA]

• [Account recovery]

• [Flags]

  if an account seems suspisus it should be flaged so that any channel, content, comments or otherwise can be monitored

• [billing]

• [Access]

Data

note

You can find the Data Structure.

On the document we want to keep all the important data, the first fetch and fast to access.

Data Structure

Model

Apps

set a permision level per secret, by default it is the accout that generated the secret.

class App {
  final String id;
  final String name;
  final String description;
  final String owner;
  final DateTime createdAt;
  final DateTime updatedAt;

  App({
    required this.id,
    required this.name,
    required this.description,
    required this.owner,
    required this.createdAt,
    required this.updatedAt,
  });

  Map<String, dynamic> toMap() {
    return {
      'id': id,
      'name': name,
      'description': description,
      'owner': owner,
      'createdAt': createdAt.toIso8601String(),
      'updatedAt': updatedAt.toIso8601String(),
    };
  }

  factory App.fromMap(Map<String, dynamic> map) {
    return App(
      id: map['id'],
      name: map['name'],
      description: map['description'],
      owner: map['owner'],
      createdAt: DateTime.parse(map['createdAt']),
      updatedAt: DateTime.parse(map['updatedAt']),
    );
  }
}

Access

Secrets

generate an app secret for each account that want to access data for this app, a secret can also be shared or set to production, meaning it is access by the frontend app and not any set user