MarinoDev/FBLA24
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity

Update readme formatting and packages

Browse Source
This commit is contained in:
Drake Marino 2024-04-16 13:56:13 +00:00
parent 9b30a0c16d
commit 501a8113b2
1 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -4,7 +4,15 @@ It uses the [Flutter Framework](https://flutter.dev/) for the front end and [Dar
Please view the README in [fbla_ui](fbla_ui/README.md) and [fbla-api](fbla-api/README.md) for specific instructions for installation and usage for each part of the app.
 
3rd Party Libraries Used:
- [dart_jsonwebtoken](https://pub.dev/packages/dart_jsonwebtoken)
- [sliver_tools](https://pub.dev/packages/sliver_tools)
- [flutter_sticky_header](https://pub.dev/packages/flutter_sticky_header)
- [pdf](https://pub.dev/packages/pdf)
- [printing](https://pub.dev/packages/printing)
- [open_filex](https://pub.dev/packages/open_filex)
- [postgres](https://pub.dev/packages/postgres)
- [argon2](https://pub.dev/packages/argon2)
[Here](https://docs.google.com/presentation/d/1ZbSE9RqobU2T-NDIm3CUtT_9nEhOm3_B47NZl1-c_QA) is the presentation used for competitions
@ -17,16 +25,17 @@ Used release 0.1.1
[Here](SLC) are my score sheets.
Questions asked (with my answers):
Q: Why did you decide to use the apps (framework and tools I assume) you used?
Q: Why did you decide to use the apps (framework and tools I assume) you used?\
A: I decided to use Flutter primarily because of it's cross-platform capabilities and it's integration with the [Material design specification](https://m3.material.io/). I also decided to use it because I had a some previous experience with Flutter and Dart, and Dart is somewhat similar to Java which I also had experience with.
This one seems to just be a clarification for the `User input is validated` catagory of the [scoring sheet](https://connect.fbla.org/headquarters/files/High%20School%20Competitive%20Events%20Resources/Individual%20Guidelines/Presentation%20Events/Coding--Programming.pdf) (page 5-6)
Q: You mentioned that you validated that the description [of the business] is required, do you validate all the inputs or just that?
This one seems to just be a clarification for the `User input is validated` catagory of the [scoring sheet](https://connect.fbla.org/headquarters/files/High%20School%20Competitive%20Events%20Resources/Individual%20Guidelines/Presentation%20Events/Coding--Programming.pdf) (page 5-6)\
Q: You mentioned that you validated that the description [of the business] is required, do you validate all the inputs or just that?\
A: I validate that all of the required fields are inputted, and I also check for a valid email address and website format.
This seems to be for the [scoring sheet](https://connect.fbla.org/headquarters/files/High%20School%20Competitive%20Events%20Resources/Individual%20Guidelines/Presentation%20Events/Coding--Programming.pdf) (page 5-6) `Code Quality` section
While looking through a binder of the presentation and source code:
Q: Is your source code all properly commented?
This seems to be for the [scoring sheet](https://connect.fbla.org/headquarters/files/High%20School%20Competitive%20Events%20Resources/Individual%20Guidelines/Presentation%20Events/Coding--Programming.pdf) (page 5-6) `Code Quality` section.\
While looking through a binder of the presentation and source code:\
Q: Is your source code all properly commented?\
A: While it is hard to comment UI code because of the nature of it, I did my best to use comments where applicable, and I also provide extensive documentation of the installation and usage of the app in the documentation in the README files.