Skip to content
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.

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

add a description of the basic entities of the database #7

Merged
merged 2 commits into from
Mar 19, 2024

Conversation

unglazedstamp
Copy link

Basic description of the database for the app.
Created a mermaid diagram and a high level description of the entities.
fixes #5

@unglazedstamp unglazedstamp added the documentation Improvements or additions to documentation label Mar 18, 2024
@unglazedstamp unglazedstamp self-assigned this Mar 18, 2024
@unglazedstamp unglazedstamp added this to the Milestone 1 milestone Mar 18, 2024
Copy link
Contributor

@octogradiste octogradiste left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love the diagram!

Two things to think about:

  1. Note that supabase automatically creates a user table. It contains User UID, Display Name, etc. but has no location attribute. I think we should store the locations of our users in a separate table, which would contain the User UID and the location. Maybe we can also drop the location for now and add it later once we implement this feature...
  2. How do we know if an event is organized by an association or not ? I could be that a user is a committee member of an association but want's to create an event which is not tied to this association. Or the user is a member of multiple associations, to which one the event is linked to ? I think we can simply add to the event a FK to the association and then ensure that the organizer is actually a committee member of this association.

@violoncelloCH
Copy link
Member

Maybe we can also drop the location for now and add it later once we implement this feature...

I agree, let's not include hypothetical things for now, but rather extend later on once we really need a field for a given feature.

@unglazedstamp
Copy link
Author

Thanks for the review,

  1. The user is now defined by supabase doc and the related information to a user are in user_profile. The location is not necessary for now, it's removed.
  2. The idea is that the user has the choice when he creates an event to do it for an association or for himself. I added a host relation and a remark

Copy link
Contributor

@octogradiste octogradiste left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@unglazedstamp unglazedstamp force-pushed the feature/db_documentation branch from daf037d to bc71edd Compare March 19, 2024 15:05
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@unglazedstamp unglazedstamp merged commit bc71edd into main Mar 19, 2024
2 checks passed
@unglazedstamp unglazedstamp deleted the feature/db_documentation branch March 19, 2024 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done in sprint 1
Development

Successfully merging this pull request may close these issues.

data structures
3 participants