LenSymphony-Web-C4

Group Members:

LEBAS Enzo, MONSTERLEET Léo, HAVEZ killian

Class diagram (Programming) :

@startuml

hide empty members
skinparam classAttributeIconSize 0
skinparam linetype ortho
skinparam linetype polyline 
skinparam nodesep 100
skinparam ranksep 80
' -------------------------- '
' LenSymphony       '
' -------------------------- '

class User {
        +Integer user_id
        +String username
        +String email
        +String password
        +String avatar
        +String role
        
        +create()
        +update()
        +login()
}

class Partition {
        +Integer partition_id
        +String title
        +String composer
        +String description
        +String genre
        +String musicxml_file
        +DateTime addition_date
        +Integer user_id

        +create()
        +update()
}

class Arrangement {
        +Integer arrangement_id
        +String name
        +String description
        +String audio_file
        +DateTime date_added
        +Integer user_id
        +Integer partition_id


        +create()
        +update()
}

class Instrument {
        +Integer id
        +String nom
}

class Track {
        +String track_name
}

class Comment {
        +Integer id
        +String title
        +String content
        +Integer rating
        +DateTime publication_date
        +Integer user_id
        +Integer arrangement_id

        +create()
        +update()
}

class Vote {
        +Boolean is_like
}

User "1" -- "0..*" Partition : Import >
User "1" -- "0..*" Arrangement : Create >
User "1" -- "0..*" Comment : Post >

Partition "1" *-- "0..*" Arrangement : Has >

Arrangement "1" -- "0..*" Comment : Receives >

Arrangement "0..*" -- "1..*" Instrument : Associate >
(Arrangement, Instrument) .. Track

User "0..*" -- "0..*" Arrangement : Vote on >
(User, Arrangement) .. Vote

@enduml

Class diagram (Database) :

@startuml

' Configuration visuelle
hide circle
hide methods
skinparam classAttributeIconSize 0
skinparam linetype polyline
skinparam nodesep 90
skinparam ranksep 80

' Couleurs et Style
skinparam class {
    BackgroundColor White
    ArrowColor #A80036
    BorderColor Black
}

' -------------------------- '
' 1. LES TABLES PRINCIPALES '
' -------------------------- '

class "**users**" as users {
    user_id : INT <<PK>>
    ..
    username : VARCHAR(50)
    email : VARCHAR(255)
    password : VARCHAR(255)
    avatar : VARCHAR(255)
    role : VARCHAR(50)
}

class "**partitions**" as partitions {
    id : INT <<PK>>
    ..
    user_id : INT <<FK>>
    title : VARCHAR(50)
    composer : VARCHAR(50)
    description : TEXT
    genre : VARCHAR(20)
    musicxml_file : VARCHAR(255)
    addition_date : DATETIME
}

class "**arrangements**" as arrangements {
    arrangement_id : INT <<PK>>
    ..
    partition_id : INT <<FK>>
    user_id : INT <<FK>>
    name : VARCHAR(50)
    description : TEXT
    audio_file : VARCHAR(255)
    date_added : DATETIME
}

class "**instruments**" as instruments {
    id : INT <<PK>>
    ..
    nom : VARCHAR(50)
}

class "**comments**" as comments {
    id : INT <<PK>>
    ..
    user_id : INT <<FK>>
    arrangement_id : INT <<FK>>
    title : VARCHAR(100)
    content : TEXT
    rating : INT
    publication_date : DATETIME
}

' -------------------------- '
' 2. LES TABLES PIVOTS (Simplifiées) '
' -------------------------- '

class "**tracks**" as tracks {
   ..
   track_name : VARCHAR(100)
}

class "**votes**" as votes {
   is_like : BOOLEAN
}

' -------------------------- '
' 3. LES RELATIONS '
' -------------------------- '

' Users & Partitions
users "1" ||--o{ "0..*" partitions : "FK: user_id"

' Partitions & Arrangements
partitions "1" ||--o{ "0..*" arrangements : "FK: partition_id"
users "1" ||--o{ "0..*" arrangements : "FK: user_id"

' Commentaires
users "1" ||--o{ "0..*" comments : "FK: user_id"
arrangements "1" ||--o{ "0..*" comments : "FK: arrangement_id"

' --- ASSOCIATIONS ---

' Tracks (Lien entre Arrangement et Instrument)
arrangements "1" ||--|{ "0..*" tracks
instruments "1" ||--|{ "0..*" tracks

' Votes (Lien entre User et Arrangement)
users "1" ||--|{ "0..*" votes
arrangements "1" ||--|{ "0..*" votes

@enduml

Data dictionary

Name of table	Field name	Data type	Constraints	Description
users	user_id	INT	PRIMARY KEY, AUTO_INCREMENT	Unique user ID.
users	username	VARCHAR(50)	NOT NULL, UNIQUE	Username visible on the profile.
users	email	VARCHAR(255)	NOT NULL, UNIQUE	Login e-mail address.
users	password	VARCHAR(255)	NOT NULL	Hash password (secure).
users	avatar	VARCHAR(255)	NULLABLE	Path to profile picture (default if null).
users	role	VARCHAR(50)	DEFAULT 'utilisateur'	Role: "utilisateur", "arrangeur", "administrateur".
partitions	id	INT	PRIMARY KEY, AUTO_INCREMENT	Unique partition ID.
partitions	user_id	INT	FOREIGN KEY, NOT NULL	The user who imported the score.
partitions	title	VARCHAR(50)	NOT NULL	Title of the musical work.
partitions	composer	VARCHAR(50)	NOT NULL	Name of the original composer.
partitions	description	TEXT	NULLABLE	Optional description of the work.
partitions	genre	VARCHAR(20)	NOT NULL	Musical genre (e.g., Jazz).
partitions	musicxml_file	VARCHAR(255)	NOT NULL	Path to the source .xml file.
partitions	addition_date	DATETIME	DEFAULT CURRENT_TIMESTAMP	Date the partition was added.
arrangements	arrangement_id	INT	PRIMARY KEY, AUTO_INCREMENT	Unique arrangement ID.
arrangements	name	VARCHAR(50)	NOT NULL	Name given to the arrangement.
arrangements	description	TEXT	NULLABLE	Description of the arrangement.
arrangements	audio_file	VARCHAR(255)	NULLABLE	Path to the generated .wav file.
arrangements	date_added	DATETIME	DEFAULT CURRENT_TIMESTAMP	Date the arrangement was created.
arrangements	user_id	INT	FOREIGN KEY, NOT NULL	The author of the arrangements.
arrangements	partition_id	INT	FOREIGN KEY, NOT NULL	The partition in the arrangements.
instruments	id	INT	PRIMARY KEY, AUTO_INCREMENT	Unique instrument ID.
instruments	nom	VARCHAR(50)	NOT NULL	Name of the instrument (e.g., Piano).
tracks	track_name	VARCHAR(100)	NOT NULL	Name of the track as defined in the XML.
comments	id	INT	PRIMARY KEY, AUTO_INCREMENT	Unique comment ID.
comments	user_id	INT	FOREIGN KEY, NOT NULL	The author of the comment.
comments	arrangement_id	INT	FOREIGN KEY, ON DELETE CASCADE	The arrangement being commented on.
comments	title	VARCHAR(100)	NOT NULL	Title of the comment.
comments	content	TEXT	NOT NULL	Content of the comment.
comments	rating	INT	NOT NULL	Rating given (e.g., 1 to 5).
comments	publication_date	DATETIME	DEFAULT CURRENT_TIMESTAMP	Date of publication.
votes	is_like	BOOLEAN	NOT NULL	True = Like, False = Dislike.

Getting started

To make it easy for you to get started with GitLab, here's a list of recommended next steps.

Already a pro? Just edit this README.md and make it your own. Want to make it easy? Use the template at the bottom!

Add your files

• Create or upload files
• Add files using the command line or push an existing Git repository with the following command:

cd existing_repo
git remote add origin https://gitlab.univ-artois.fr/enzo_lebas/lensymphony-web-c4.git
git branch -M main
git push -uf origin main

Integrate with your tools

• Set up project integrations

Collaborate with your team

• Invite team members and collaborators
• Create a new merge request
• Automatically close issues from merge requests
• Enable merge request approvals
• Set auto-merge

Test and Deploy

Use the built-in continuous integration in GitLab.

• Get started with GitLab CI/CD
• Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)
• Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy
• Use pull-based deployments for improved Kubernetes management
• Set up protected environments

---

Editing this README

When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to makeareadme.com for this template.

Suggestions for a good README

Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.

Name

Choose a self-explaining name for your project.

Description

Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.

Badges

On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.

Visuals

Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.

Installation

Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.

Usage

Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

Support

Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.

Roadmap

If you have ideas for releases in the future, it is a good idea to list them in the README.

Contributing

State if you are open to contributions and what your requirements are for accepting them.

For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.

You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.

Authors and acknowledgment

Show your appreciation to those who have contributed to the project.

License

For open source projects, say how it is licensed.

Project status

If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.