Create your very own dashboards and configure them just the way you like it! Dashboard Configurations is a Machine-to-Machine API that lets you configure dashboards with currency exchance rates, weather data and more per country.
Note: The documentation you can read from this README.md file and other Markdown files in the docs directory are meant for internal use only. Public documentation for this project does not and will not exist. The simple reason is this is an assignment.
To get started, you need Go version 1.21. Head over to the downloads page to find the binary for your system.
We also recommend to install Git. On *NIX systems, this is usually installed by default, or you can use your system's package manager to install it. For NT, head over to Git's downloads page to find the binary for your system.
The project uses Google's Cloud Firestore as DBMS. Head over to your Firestore instance and download the public key.
Clone the project to your system:
git clone https://git.gvk.idi.ntnu.no/course/prog2005/prog2005-2024-workspace/joafsb/assignment2.git
cd assignment2
Move your public key to the project. Now you need to edit the configuration file and insert the key's location. The configuration is config.yaml. Under secrets/firebaseKey, insert the file path to the key. It supports both absolute and relative paths.
Run the project
go run main.go
The project has Docker support. Build and run the container as follows:
docker-compose build
docker run -d -p 0.0.0.0:8080:8080 assignment2-demoapp
You can also expose the port only to localhost as follows:
docker run -d -p 127.0.0.1:8080:8080 assignment2-demoapp
The project consists of the following four modules:
Read the API documentations by navigating to the above links.
Below are links to more documentations about the implementation of this project's components. Read more about them by navigating to the below links: