Skip to content

Commit

Permalink
Documentation: Add developer quickstart guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ValentinFutterer authored and andresTabiTuwien committed Jan 27, 2025
1 parent 1c5b14b commit 282201b
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Added "Principle Investigator" and "Project Coordinator" as contributor roles [#285](https://github.com/tuwien-csd/damap-backend/pull/285).
- Added option to configure html title [#320](https://github.com/tuwien-csd/damap-backend/pull/320).
- Added backend support for configurable banners [#311](https://github.com/tuwien-csd/damap-backend/pull/311).
- Added develop quickstart guide documentation [#329](https://github.com/tuwien-csd/damap-backend/pull/329).

### Changed

Expand All @@ -31,6 +32,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Changed cost coverage text into a placeholders [#307](https://github.com/tuwien-csd/damap-backend/pull/307).
- Removed detailed guidance table from FWF template [#316](https://github.com/tuwien-csd/damap-backend/pull/316).
- Added Internal project ID and renamed grant information to project number in FWF section I. [#327](https://github.com/tuwien-csd/damap-backend/pull/327).
- Added Project code of the funding body and Internal project ID to HE on page 1 [#327](https://github.com/tuwien-csd/damap-backend/pull/327).
- Added Funder field to SE in the project details section [#327](https://github.com/tuwien-csd/damap-backend/pull/327).

### Resource Files

Expand Down
32 changes: 31 additions & 1 deletion INSTALLATION.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,35 @@
# Installation

## Quickstart guide for development

DAMAP is made up of two parts: a backend (this repository) and a [frontend](https://github.com/tuwien-csd/damap-frontend).
You will probably need to set up both of these for development. DAMAP also requires extra services, which are provided via
docker containers.

```shell
cd docker
docker compose up -d
```
The above commands start the dockerized setup. By default, docker pulls back and frontend
images from GitHub - the docker frontend can then be reached at http://localhost:8085/, use user/user for username/password.
For more info about the docker setup, see [the section below](#run-with-docker-compose). The containerized DAMAP instance
is good for testing out the software and showing it to others, but not for development. For development, it is better to
run local instances of the front and backend. The backend can be started using maven with the following command:

```shell
mvn compile quarkus:dev
```

Start the frontend using the command:

```shell
nx serve damap-frontend
```
The locally run frontend will now be accessible at http://localhost:4200/, same username and password. The local instances
will also automatically connect to the services provided by the docker containers. Now you have a running DAMAP setup with
autoreload on changes to the source files.


## Run with docker-compose

In order to set up the whole system consisting of multiple components a
Expand Down Expand Up @@ -71,7 +101,7 @@ docker-compose exec damap-db psql -U damap damap
## Custom Deployment

In order to adapt the project and deploy it in your own institutional environment
follow the [deployment instructions](INSTALLATION.md).
follow the [custom deployment instructions](CUSTOMISING.md).

## OpenAPI Documentation

Expand Down

0 comments on commit 282201b

Please sign in to comment.