Skip to content

Commit

Permalink
Merge branch 'develop' into documentation_jonathan
Browse files Browse the repository at this point in the history
  • Loading branch information
uo283642 authored Feb 16, 2024
2 parents ddcb201 + 64dc143 commit 3062a57
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 21 deletions.
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"asciidoc.antora.enableAntoraSupport": true
}
9 changes: 6 additions & 3 deletions docs/src/02_architecture_constraints.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

|*OS/Browser Independence* |The project must be available to the maximum amount of users feasible. That includes support for mainstream OSs (_Windows_, _Linux_, _MacOS_) and browsers. (_Chrome_, _Safari_, _Firefox_, _Edge_)
|*Usage of _REACT_* |The _REACT JS_ framework will be used to develop the front-end of the project.
|*Docker* | The application will operate within a Docker environment.
|*Version Control* |In order of the project to be graded adequately, it must use _GitHub_ as its version control software. The contributions of each team member and agreements reached must be easily traceable.
|*Continuous integration and delivery* |The development must progress through frequent integration of small changes into the main branch. New features must be automatically deployed with ease. (In our case, using _Docker_)

Expand Down Expand Up @@ -36,9 +37,11 @@
|Constraint |Explanation

|*Use of English* |The totality of the project must be written in English, as to facilitate its understanding internationally.
|*Documentation format* |We have decided to use the _ARC42_ template structure.
|*Programming Language conventions* | We ought to follow the conventions specific to the programming languages we're employing.
|*Documentation format* |The documentation must adhere to the Arc42 method, ensuring it is clear, simple, and effective.
|*Clean code* |In order to ease the understanding and maintenance of the project, all code written must be organized, descriptive and easy to read.
|*Ease of use* |The application needs to have an intuitive design, as well as the capability to help and guide users towards their goal. User experience has to be as seamless as it can be made.
|*Accesibility* |The application should be user-friendly, allowing all individuals to navigate effortlessly, irrespective of any disabilities, ensuring inclusivity for all users.
|*Microservices* | The application will be divided into microservices to facilitate its development.
|===

****
=======
57 changes: 39 additions & 18 deletions docs/src/04_solution_strategy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,51 @@ ifndef::imagesdir[:imagesdir: ../images]
[[section-solution-strategy]]
== Solution Strategy

=== Technology Decisions

[role="arc42help"]
****
.Contents
A short summary and explanation of the fundamental decisions and solution strategies, that shape system architecture. It includes
In order to develop the application and adhere to the constraints, we selected the following technologies:

* technology decisions
* decisions about the top-level decomposition of the system, e.g. usage of an architectural pattern or design pattern
* decisions on how to achieve key quality goals
* relevant organizational decisions, e.g. selecting a development process or delegating certain tasks to third parties.
- ReactJS: JavaScript library that streamlines the development of graphical interfaces for web applications.
- TypeScript: Extension of JavaScript, bolstering it with type support for improved development.
- GitHub: Platform offering remote repository services for project development, task management, and version control.
- MongoDB: A non-linear database selected to oversee storage of diverse application contents, with each microservice possessing its dedicated database.
- NodeJS: Facilitates efficient management of asynchronous events, notably beneficial for scalable network applications and database administration.
- Docker: Employed for seamless deployment of the application environment.

.Motivation
These decisions form the cornerstones for your architecture. They are the foundation for many other detailed decisions or implementation rules.
=== Top-level Decomposition

.Form
Keep the explanations of such key decisions short.
==== Diagramming tools

Motivate what was decided and why it was decided that way,
based upon problem statement, quality goals and key constraints.
Refer to details in the following sections.
We will use PlantUML and UMLet for creating the documentation's diagrams.

=== Approaches to Achieve Top Quality Goals

.Further Information
[cols="1,2,3"]
|===
| Quality Goal | Scenario | Solution Approach

See https://docs.arc42.org/section-4/[Solution Strategy] in the arc42 documentation.
| Privacy
| Users seek reassurance in the safety and privacy of their data within our app.
| Ensuring user data security and privacy within the application.

****
| Usability
| Seamless execution of all application functions is crucial for user satisfaction.
| Optimizing usability through the utilization of React.

| Maintainability
| Application architecture must facilitate seamless addition or modification of functionalities with minimal code changes.
| Implementing design patterns and adhering to code conventions to ensure clean and maintainable code. Additionally, prioritizing testing during development for long-term maintainability.

| Scalability
| The application's design must accommodate changes effortlessly throughout its lifecycle.
| Employing a microservices approach to minimize code repetition and enhance understanding of application distribution, ensuring future scalability.

|===

=== Organizational Decisions

We've established the following organizational guidelines:

- *Language*: Adhering to international standards, the project, encompassing code and documentation, will be developed in English as the primary language.
- *Issues:* All deliberations will be documented as issues on GitHub.
- *GitHub Projects:* Employing this tool, we'll plan the application's development process, utilizing GitHub's integrated features for efficient project management in accordance with AGILE methodology.

0 comments on commit 3062a57

Please sign in to comment.