Skip to content
Snippets Groups Projects
Commit 27d83465 authored by Jakub Konvička's avatar Jakub Konvička
Browse files

fix: set default parameter, feat: modify README.md

parent 3a6ed4fe
Branches
1 merge request!15merge: develop into main
Pipeline #941 passed with stages
in 6 minutes and 21 seconds
# DiplomaThesis
# Diploma Thesis - Source Code to UML Diagrams Transformation
[![Quality gate](https://sonar.cs.vsb.cz/api/project_badges/quality_gate?project=kon0379DiplomaThesis&token=sqb_60bd3c2b739938ceeb07e31418d7d9d9f32390d5)](https://sonar.cs.vsb.cz/dashboard?id=kon0379DiplomaThesis)
## 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](#editing-this-readme)!
## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin https://gitlab.vsb.cz/kon0379/diplomathesis.git
git branch -M main
git push -uf origin main
```
## Integrate with your tools
- [ ] [Set up project integrations](https://gitlab.vsb.cz/kon0379/diplomathesis/-/settings/integrations)
## Collaborate with your team
## Project Overview
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
The goal of this project is to develop a methodology for converting source code into UML diagrams. The conversion process will take place from source code to the OMG XMI specification for UML. The sample implementation will support the conversion of source code from a programming language (e.g., C++) to UML diagrams interpreted by the XMI specification (activity and class diagrams). Testing will be conducted on generated code from ChatGPT and Bard.
## Test and Deploy
## Project Tasks
Use the built-in continuous integration in GitLab.
### 1. State of the Art
- Research available specifications and tools related to source code to UML diagram conversion.
- Familiarize yourself with existing methodologies and best practices.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
### 2. Requirements Definition
- Clearly define the requirements for the conversion process.
- Specify the desired features of the tool.
- Define supporting functions based on the project's objectives.
***
### 3. Architecture and Design
- Develop an architecture for the conversion tool.
- Create a detailed design that outlines the components and interactions.
- Ensure compatibility with the OMG XMI specification for UML.
# Editing this README
### 4. Implementation
- Code the conversion tool according to the defined architecture and design.
- Implement support for converting source code from a selected programming language to UML diagrams.
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!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
### 5. Testing
- Test the tool on generated code from ChatGPT and Bard.
- Ensure the accuracy and completeness of the generated UML diagrams.
- Address and resolve any issues or discrepancies in the output.
## 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.
### 6. Conclusion and Evaluation
- Summarize the findings and outcomes of the project.
- Evaluate the effectiveness and efficiency of the developed tool.
- Discuss potential improvements or future enhancements.
## Name
Choose a self-explaining name for your project.
## Repository Information
## 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.
[![Quality gate](https://sonar.cs.vsb.cz/api/project_badges/quality_gate?project=kon0379DiplomaThesis&token=sqb_60bd3c2b739938ceeb07e31418d7d9d9f32390d5)](https://sonar.cs.vsb.cz/dashboard?id=kon0379DiplomaThesis)
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
This repository contains the source code and documentation for the diploma thesis on source code to UML diagrams transformation. The provided SonarQube quality gate indicates the overall quality of the project.
## License
For open source projects, say how it is licensed.
Feel free to explore the codebase and documentation for a detailed understanding of the implemented solution. If you encounter any issues or have suggestions for improvement, please open an issue or submit a pull request.
## 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.
Thank you for your interest in this project!
......@@ -23,7 +23,7 @@ namespace WebAPI.Controllers
private readonly IConfiguration _configuration;
private int tokenValidityMinutes => _configuration?.GetValue<int>("UserManagement:TokenValidityMinutes") ?? 30;
public ApiController(ILogger<ApiController> logger, IConfiguration configuration, string dbPath)
public ApiController(ILogger<ApiController> logger, IConfiguration configuration, string dbPath = "default-users.json")
{
_logger = logger;
_configuration = configuration;
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment