Docs > Contributing > As a developer > Creating models (getting started)

OTTAA-Project / ottaa_project_flutter

Join us to create the first predictive augmentative communication platform for speech-impaired children!

https://ottaa-project.github.io/

GNU General Public License v3.0

10 stars 4 forks source link

Docs > Contributing > As a developer > Creating models (getting started) #90

Closed VicColombo closed 2 years ago

VicColombo commented 2 years ago

Hi @hectoritr,

in the original Readme there's this section called Creating models which will now be moved to Contributing > As a developer. This is the fragment I'm referring to:

Create models

run flutter pub get to get the dependencies.
run flutter pub run build_runner build to generate the model class code.
run flutter run to run the project.
run flutter packages pub run build_runner build --delete-conflicting-outputs if there are some errors for models building.
run flutter build web --release --web-renderer html for building the project.
run flutter deploy for deploying it on the master.
run firebase deploy --only hosting:dev-ottaaproject for deploying it on dev.
- Web Page

I have two questions about this:

Would it be correct to rename it "Create your own models"/ "Create your own version of the app", or something like that?
I'd like to remove the website link at the end of the list it but just want to check first if it's there for a particular reason.

hectoritr commented 2 years ago

Probably a good name for it would be "Setting up you IDE" or something like this @asimjawad what do you think?
Yeap remove.

Also the steps needed are the following run flutter pub get to get the dependencies. run flutter pub run build_runner build to generate the model class code. run flutter run to run the project. run flutter packages pub run build_runner build --delete-conflicting-outputs if there are some errors for models building.

The other I think can be kept internally

asimjawad commented 2 years ago

Sorry for the late reply here, one of my cat was sick. The creating models section is for Json_serializable and json_annotation plugins, we are handling the parsing dynamically and these models/plugins help us in doing that. You can say that this step is one of the main part of the process in setting up the app.

VicColombo commented 2 years ago

@hectoritr, @asimjawad thank you both for your replies! (hope the cat is better :cat2:).

How about this then?:

Get started: setting up your IDE

run flutter pub get to get the dependencies.

run flutter pub run build_runner build to generate the model class code.

run flutter run to run the project.

run flutter packages pub run build_runner build --delete-conflicting-outputs if there are some errors for models building.

I have not included @asimjawad 's explanation of this section but can do it if you think it's a good idea.

As I mentioned before, this section used to be at the beginning of the main README file and is now going to be included in the Contributing doc under "Contributing as a developer", the reason for this change is that I assumed if someone is setting up the app it's because they are developers/want to check or do something to do with code. Could you confirm this intuition or refute it if you think it's better for this section to go back to the README doc?

asimjawad commented 2 years ago

The first 3 points from the 1st can be added at the top of the README. The reason is that even if someone is not a developer and they want to run it, they can just simply type these commands and do it. In case of a first time built the 4th command is not required because everything will be building from scratch. For the 2nd point yeah, we can add these there for the developers too. Otherwise they would be going through the code to find the issue.

asimjawad commented 2 years ago

people usually reads the document in full capital like README first 😂

VicColombo commented 2 years ago

Thanks for all the info @asimjawad & @hectoritr! =)