Skip to content

Trivial english corrections for overview.md #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bruprai wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Trivial english corrections for overview.md #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/001-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,19 +118,19 @@ This phase will be concluded when we have a detailed plan of the technical setup

### Phase 1: Basic data storage structure and models involved

In this phase we want to go over all the functionality we're looking at adding into the app. This will illuminate the models that we'll require to build all the services. We will identify key models and decides on which properties will be useful to have in the application.
In this phase, we will review all the functionality we plan to add to the app. This will clairfy the models that we'll require to build all the services. We will identify key models and decide on which properties will be useful to have in the application.

A success for this phase will be a detailed breakdown of the models we'll have in the application as well as the purpose they serve, their properties and in which parts of the system they will be used.

### Phase 2: Data population and development prep

In this phase we are still not writing code haha. Planning and structure is important for such a large system, and we're still going to miss things. Here we will use the models defined above and generate some fake data for use to use when we finally do start the development. This process will give us a first review of our database structure we defined above and will show any flaws that we might have made in terms of how to store everything. This will also be very helpful during the development to ensure that we have data to work it.
In this phase we are still not writing code haha. Planning and structure is important for such a large system, and we're still going to miss things. Here we will use the models defined above and generate some fake data for us to use when we finally do start the development. This process will give us a first review of our database structure we defined above and will show any flaws that we might have made in terms of how to store everything. This will also be very helpful during the development to ensure that we have data to work it.

A success for this phase will be a database with enough information in it to allow us to display some basic product when we get to that point.

### Phase 3: Customer App Setup and Authentication

Here we will create the mobile flutter project and setup firebase authentication. We will also make sure that when a user signs up we create them a profile on the database where we can manage all their information. This will be profile information for us to identify who we're communicating with.
Here we will create the mobile flutter project and setup firebase authentication. We will also ensure that when a user signs up, we create a profile for them in the database where we can manage all their information. This will be the profile information for us to identify who we're communicating with.

A success for this phase will be a flutter app where we can sign in. A folder with a firebase project for user management that contains the cloud function to create a new user model entry in firestore when the user is created. A firebase app setup to allow for authentication.

Expand Down