Git Product home page Git Product logo

engine-backend's Introduction

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.9.1 or higher)
  • Postgres & libpq (recommended 11)
  • Fourmolu (recommended 0.8.2.0, optional)
  • HLint (recommended 3.4.1, optional)
  • Docker (recommended 19.03.0-ce) - for build of production image
  • document-worker (corresponding version)
  • mailer (corresponding version)

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

$ fourmolu -i (find <application>/src -name '*.hs')
$ fourmolu -i (find <application>/test -name '*.hs')

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.

engine-backend's People

Contributors

dependabot[bot] avatar janslifka avatar josefdolezal avatar mareksuchanek avatar martin-bednar avatar roper79 avatar touwwouter avatar vknaisl avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.