The API backend of [smartmat.app](https://smartmat.app). Smartmat helps you avoid waste and gives full control of you recipes, and items in your fridge.
"SmartMat, your smart food companion"
## Links
## Links
-**Frontend:** https://smartmat.app
-**Frontend:** https://smartmat.app
...
@@ -12,89 +19,80 @@
...
@@ -12,89 +19,80 @@
## Getting started
## Getting started
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
1. Clone SmartMat using:
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)!
-[ ] [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
#### For HTTPS:
-[ ] [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:
-[ ] [Set up project integrations](https://gitlab.stud.idi.ntnu.no/idatt2106-v23-03/backend/-/settings/integrations)
3. Install dependencies and create JAR
## Collaborate with your team
`mvn clean install`
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
4. Or, run the application directly
-[ ] [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)
-[ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
`mvn spring-boot:run`
Use the built-in continuous integration in GitLab.
## Dockerfile
This Dockerfile is used to build and run the SmartMat backend in a Docker container. It is based on the Eclipse Temurin JDK and JRE Alpine images to keep the image size small and ensure consistency in the Java environment.
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
1.**Install Docker** from :
-[ ] [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)
***
[Docker's official website](https://www.docker.com/products/docker-desktop).
# Editing this README
2.**Build the Docker image**:
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.
`docker build -t your-image-name .`
## Suggestions for a good README
3.**Check the built image**:
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
`docker images`
Choose a self-explaining name for your project.
## Description
4.**Run the Docker container**:
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.
`docker run -d --name your-container-name -p 8080:8080 your-image-name`
## Badges
5.**Access the application**:
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
`http://localhost:8080`
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
6.**Stop the container**:
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
`docker stop your-container-name`
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
## Tests
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.
1.**Run Unit tests:**
## Roadmap
`mvn test`
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
2.**Get jacoco coverage reports:**
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.
The reports are located in `target -> site -> jacoco -> index.html`
## Authors and acknowledgment
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
Show your appreciation to those who have contributed to the project.
- Magnus Lutro Allison
## License
- Anders Montsko Austlid
For open source projects, say how it is licensed.
- John Fredrik Bendvold
- Pedro Pablo Cardona Arroyave
## Project status
- Vebjørn Andreas Lind‐Solstad Myklebust
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.
- Birk Øvstetun Narvhus
- Stian Lyng Stræte
## Thanks
- The developers of [kassal.app](https://kassal.app) for use of their products API.
- The faculty of NTNU for providing helpful advice and guidance trough the process. Especially:
