Home

Welcome! 🎈 🪂

Welcome to the Mesmorize wiki! Here you can find all the details about our project, and how to contribute to it. This is a simple and short project, so we came up with our own organization system to keep things simple and fast!

• See our Domain Model here. We started super simple: so this may change a lot!!
• See our API Documentation here
• See the features we plan to implement here

Tech Stack 👨‍💻 👩‍💻

• Backend: Java, Spring Boot with method level security at all API endpoints (OAuth2). Domain model available here
• Frontend: Angular
• CI with GitHub Actions

Development Process 🧠 💻

• We keep track of features and tasks we would like to implement on this wiki page. Feel free to pull a feature or add one that has not been assigned!

  • Features are specific functionalities of the app, labelled F(number), eg. F1
  • Tasks are more general - code or setup that is required for all features to work. They are labelled T(number), eg. T1.
  • For this project, we will unit test repository and service methods, but integration tests will be done with Postman

• Every feature or task has an associated issue. Everyone works on a feature or task within a specific branch 🌲

  • Issue Names have the format: #FeatureOrTaskNumber - Description of issue. Eg. "T1 - Setup file structure and Spring Boot Security System"
  • Branch names have the format: F(featureNumber), eg. F3 if its feature number 3, or T(taskNumber), eg. T1 if it is task number 1
  • Commits within a branch are linked to the issue they address and have the format: "#IssueNumber - Description of progress 😄"

• When a feature or task is complete, a pull request is submitted to dev, the development branch. One person reviews the PR before it is merged to main

• When the first iteration of the functionality is complete, we will merge everything to main!