Skip to content
develop
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Data Stewardship Wizard Engine Backend

User Guide Engine Backend CI License CII Best Practices

Backend application for Data Stewardship Wizard

Applications

  • Wizard (<application> = engine-wizard)
  • Registry (<application> = engine-registry)

Contribute

For contributing guidelines, please read CONTRIBUTING and relevant section in our guide.

Requirements

  • Stack (recommended 2.3.1 or higher)
  • Postgres & libpq (recommended 11)
  • Hindent (recommended 5.3.2, optional)
  • HLint (recommended 3.3.4, optional)
  • Docker (recommended 19.03.0-ce) - for build of production image
  • document-worker (corresponding version) - for document generation, RabbitMQ required

Build & Run

For running application it's need to run MongoDB database and set up connection in configuration file.

Run these comands from the root of the project

$ stack build <application>
$ stack exec <application>

Run tests

Run these comands from the root of the project

$ stack test <application>

Format code

Create a bash script which will do the work for you. Run the script from the root of the project

$ find <application>/src -name '*.hs' | while read line ; do hindent $line ; done
$ find <application>/test -name '*.hs' | while read line ; do hindent $line ; done

Code coverage

Run these comands from the root of the project

$ stack build <application>
$ stack test <application> --jobs=1 --fast --coverage --ghc-options "-fforce-recomp"

Build an app version and built date

Run these comands from the scripts folder

$ ./<application>/build-info.sh

License

This project is licensed under the Apache License v2.0 - see the LICENSE file for more details.