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:
This project includes the HTTP-Bridge project and the modified version of Scorpio Broker.
The HTTP Bridge serves as a middleware between the Scorpio Broker and the PostgREST API. It is responsible for fetching data from the API, translating it into the NGSI-LD format, and returning a structured response that conforms to the NGSI-LD data model.
- We recommend using Microsoft's OpenJDK version since it provides a simple and seamless installation.
-[Node.js (v14 or higher) & NPM](https://nodejs.org/en/download)
Below you will find a sample installation of JDK and Maven an **Ubuntu 22 LTS** environment. For any other distros please look the respective links above.
-[ ] [Set up project integrations](https://netsim.cs.uowm.gr/gitlab/depe/http-scorpio/-/settings/integrations)
## Collaborate with your team
## Scorpio Broker
-[ ] [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)
Move into the `scorpio-broker` folder and execute the following:
## Test and Deploy
### Running Scorpio Broker
Use the built-in continuous integration in GitLab.
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
-[ ] [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)
***
# Editing this README
1. Build the project and the docker images with Maven:
```bash
sudo mvn clean package -DskipTests-Pdocker
```
**This will take a while so please wait patiently.**
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](https://www.makeareadme.com/) for this template.
2. Start the broker using Docker Compose:
```bash
sudo docker compose -f docker-compose-dist.yml up --build
```
## Suggestions for a good README
3. Access the broker:
The broker is now running on port 9090.
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.
### Stopping Scorpio Broker
## Name
Choose a self-explaining name for your project.
- To stop the stack:
```bash
sudo docker compose -f docker-compose-dist.yml down
```
## 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.
## HTTP Bridge
## 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.
Move into the `http-bridge` folder and execute the following:
## 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.
### Running HTTP Bridge
## 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.
1. Copy the `.env-sample` file and paste it as `.env`
2. Modify the `.env` values as needed
3. Install npm packages
```bash
npm install
```
4. Build the Docker image
```bash
sudo docker build -t http-bridge .
```
5. Run the Docker container
```bash
sudo ocker run -d--name http-bridge -p 8080:8080 --env-file .env http-bridge
```
## 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.
**The bridge will be accessible at: {HOST}:{PORT}**
## 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.
Default: http://localhost:8080
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
### Stopping HTTP Bridge
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
- To stop the running container:
```bash
sudo docker stop http-bridge
```
- To remove the container:
```bash
sudo docker rm http-bridge
```
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.
### NGSI-LD Entity Types
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.
Show your appreciation to those who have contributed to the project.
Additional entity types can be added dynamically by extending the Type Mapping Configuration.
## License
For open source projects, say how it is licensed.
To support more NGSI-LD models:
## 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.
1. Add a new type mapping in ``typeMaps/``
2. Extend NGSITranslator.js to handle the new entity type
3. Modify generalControllers.js to process the new queries
