Skip to content

PMolnes/bachelor-vp-frontend

Repository files navigation

Voice Pick Frontend

Frontend repository containing the source code of the iOS mobile application voice pick.

Table of Contents

  1. Project Structure
  2. Getting Started

1. Project Structure

The application is written in Swift using SwiftUI. The source code is located in the voice-pick-frontend.

voice-pick-frontend - source code lib - Facade classes wrapping third party libraries layouts - For layout components, like bottom navigation features - Features in the app described in more details belove utils - Global utility classes pages - Pages the app consists of models - Global models used throughout the app service - Global service classes used throughout the app components - Global UI components used throughout the app

There are three special directories; lib, features and layouts.

  • The lib folder consists of facade classes, wrapping third party libraries that is used in the application. For example, if axios is used, a wrapper class should be create exposing method that can be used throughout the application. If axios need to be updated or changed, every change can be done in one location where this wrapper class is defined (underneath the lib directory).

  • The features directory consists of sub-directory, one for each feature found in the application. In each sub-directory, there will be more directories for; components, services, models, etc... Here you will find classes that are not global and only used for the respective feature. Example of feature directory:

features:
    authentication:
        components:
            forms:
                LoginForm
                SignUpForm
        services:
            AuthService
        models:
            User # This could maybe be a global model
            AuthRequestDto
  • The layout directory consists of layout components that are used throughout the application like; bottom navigation bar, top header, menu drawers, etc...

Link to video explaining the structure: Youtube Video

2. Getting started

TODO: ...

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages