Mockup generation taskforce consensus of architecture and development patterns #191
Labels
No labels
_CRITICAL_
API
app
backEnd
Blocked-waiting-for-further-changes
bug
bug-only-on-server-for-mobile-not-webpage
Bug-Report-After-Merge
cleanup
close
design
duplicate
enhancement
feature request
frontEnd
further-changes-needed
future-problem-not-fixint-this-period
help wanted
invalid
last-week-issue-to-fix
library
low-priority
needs input
needs review
not-implemented.
project documentation
question
research
reviewed
Script
security
SQL
style
Team 1
Team 2
team leaders
test-creation
testing
topLevel
unassigned
Under-review
wontfix
No milestone
No project
6 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
Andras/BoundlessFlowCampus2K#191
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
We'll have a meeting with all of the developers that is working on the mockup generation to make sure that we have a uniform standard in the pattern.
This might be a base to form the guidelines regarding mockup generation.
Related to issue: #126 #52 #127 #142
The result from this meeting can you find here: https://git.webug.se/Andras/BoundlessFlowCampus2K/wiki/Mock-Api-Documentation
closing this issue.
This has been approved without review, i will reopen the issue.
This seems to be more of a guide to how we create our mock API's then documentation about how to use them for future developers. This is not an actual issue as it is the intended purpose of this wiki section AND the project plans on swapping over to intended API's in the future. But i would suggest changing the name of the wiki page away from "mock API documentation" to something more similar to "rules of creating mock API" or "mock API creation guidelines" as documentation is a key word for finding information about how to use a tool in the future.
The emphasis on the existence of unique functionalities between sensors and the need to create README files is good and will make it easier for future developers to understand and use the mockup API's. But the guidelines seem vague for new developers in case they want to or need to create their own mockup API in the future. Include some examples of code and structure for future developers.
Additionally, i don't know if this is necessary, but we might want to include some form of guidelines or documentation about how the mockup's store information so it can be either uniform between mockup API's or match the JSON file structure of the intended API the mockup is currently representing, and thus make it easier to fetch data for different data handlers and swapping over to intended API's in the future.
Having some stadards for how to create mockup data might be sound but each mockup will still need documentation about how to use that API and what is returned.
The rules:
Every micro service shall have a database. At the moment we use sensor database until the investigation about the database structure is done.
This might need some talk with teamleaders, personally i dont think a database for each is nessasary as we would just create manny dbs with one table each, insted we can just add a table to the postgreSQL that exist. This fuctionality is implimented in the middleware as functions witch gets called with MQTT using this would also make the data uniform as it gets saved the same way
Map Structure shall follow Object oriented (use of classes) check out the parking service structure.
This seem good to me, and makes it easy to use.
Every micro service has unique functionalities such as electricity and sensor then some parts may not be similar.
Having a README: What to include:- How it integrates from frontend and back
This is in my oppinion the only really important part documentation as wiki and readme, Other classmates will use the data so how we create the data isnt that important as its just a mockup the important part is that others know how to use this API and know what gets returened for the views that will be created and that the data created is "realistic".
@a24hirsa wrote in #191 (comment):
I agree 100%, and this was briefly discussed with the leaders as well. We'll have to discuss this during the meeting to make the overall task a bit less fuzzy.
@c24danli wrote in #191 (comment):
This was discussed with team leaders as well, and it also makes sense for each service to have its own database as we're working with the microservice architecture and therefore want to emphasize on loose coupling as much as possible so different people/teams can work on the different services without stepping on each other's toes. Furthermore, should there be issues with one database it won't affect the other services.
One could argue that having a single shared database is fine for a very quick prototype(especially when our database is as sparse as it is now), but the question is how much technical debt we want to leave for future developers.
We had a pair review with @c24danli and clarified some of the points.
Is this being documented/worked with? Just asking for an update
Yeah, we said will update thie wiki when we are done with overall structure of the mockups. This can be kept open for not forgetting
Meeting held 30/04 about architecture, these are the decisions:
@b24johka wrote in #191 (comment):
We'll need new issues for the following points here:
-1: one new issue for roombooking,
one for parking,
one for energy.
-2: one new issue.
-3: one new issue.
-4: one new issue.
-5: Probably one new issue that the people in the mockup group will have to cooperate on?
-6: This probably goes hand-in-hand with 1. Doesn't seem like they need to be separate issues as they will both happen at the same time in the same task.
-7:
one for room booking
one for power
one for parking.
The issues to the diagrams are created. Don't create any new issues on those.
we have left the documentation which will be done in this issue. #910. I close this issue now
Good job everyone.!