Skip to content
GitLab

Project Management API · Changes

Page history
Update Project Management API authored by Dimitris Tsoukalas's avatar Dimitris Tsoukalas
Hide whitespace changes
Inline Side-by-side
Project-Management-API.md
View page @ bb7267e8
# VM4SEC Projects API
Welcome to the VM4SEC Dashboard Project API repository. This project contains the C# and Docker files for the VM4SEC Dashboard project's backend.
Welcome to the VM4SEC Dashboard Project API repository. This page describes the steps that need to be followed for installing and setting up the back-end of the **VM4SEC Dashboard Project API** on your local machine. This project contains the C# and Docker files for the VM4SEC Dashboard project's backend.
The VM4SEC Dashboard Project backend relies on [PostgreSQL](https://www.postgresql.org/) and C# for providing a RESTfull API for creating, editing and deleting projects.
......@@ -9,7 +9,7 @@ The VM4SEC Dashboard Project backend relies on [PostgreSQL](https://www.postgres
In this section, we provide instructions on how the user can build a new Docker Image that contains the VM4SEC Dashboard Project backend. We highly recommend the users to select this way of installing the backend server, as it constitutes the easiest way.
- **Step 1**: Download and install [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/install/)
- **Step 2**: Clone the latest VM4SEC Dashboard Project API version and navigate to the home directory. You should see a `docker-compose.yml` file, which contains the Docker compose steps. If needed, you can configure various parameters according to your needs, such as the names of the containers or the port (remember to update also the the `.env` configuration file within the VM4SEC Dashboard).
- **Step 2**: Clone the latest VM4SEC Dashboard Project API version from [this link](https://gitlab.seis.iti.gr/vm4sec/vm4sec-dashboard-project-api.git) and navigate to the home directory. You should see a `docker-compose.yml` file, which contains the Docker compose steps. If needed, you can configure various parameters according to your needs, such as the names of the containers or the port (remember to update also the the `.env` configuration file within the VM4SEC Dashboard).
- **Step 3**: In the home directory of the VM4SEC Dashboard Project API, open cmd and execute the following command:
```bash
sudo docker-compose up --build -d
......