Building Information Enhancer (AMOS SS 2024)

📢 About the Project

Welcome to the official repository for the CODE.ING group, developing an open-source Building Information Enhancer software for the BUILD.ING partner and the AMOS 2024 project. Together, we create a Building information system for potential energy savings. To read about the architecture of our service visit our GitHub wiki.

🚀 Setup & Deployment

This project is integrated with a full CI/CD pipeline, thus deployed automatically on the web. However, it is possible to deploy a production-ready system on your local machine using Docker. For further information on the CI/CD pipeline visit our GitHub wiki documentation.

📦 Deployment using Docker

To deploy the project on your local machine using Docker Engine, follow the instructions below:

1. Clone this repository (https://github.com/amosproj/amos2024ss04-building-information-enhancer).
2. Before deploying the project be sure you have installed the Node.js ( >= 20.12.2) and a running Docker Engine.
3. Run the npm run deploy command in the root folder of the repository.
4. Connect to the frontend at port 80 (localhost:80).

💻 Developement Deployment

In order to deploy and/or develop one or more services without Docker, follow the instructions below:

1. Clone this repository (https://github.com/amosproj/amos2024ss04-building-information-enhancer).
2. Before deploying the project make sure you have installed the Node.js ( >= 20.12.2) and Dotnet SDK ( >= 8.0.3).
3. Run the npm run setup:<os> command to download all necessary packages and build the services, replacing <os> with windows, linux or macos based on your operating system.
4. If you want to develop the frontend service, run the npm run deploy:backend:api to deploy the backend and in a new terminal run the npm run deploy:frontend:dev command to deploy the frontend developement server.
5. To develop one of the backend services using Visual Studio IDE (for other IDEs, search online), go to the service's subfolder in the backend folder and open the corresponding .sln file.

👥 The Team