reactific / riddl   0.18.0

Apache License 2.0 Website GitHub

A language and tooling for opinionated design specification.

Scala versions: 2.12 2.13
sbt plugins: 1.0

Code Build Status Documentation Build Status Coverage Status CLA assistant Scala Steward badge License

Lines of Code Technical Debt Code Smells Vulnerabilities Security Rating Reliability Rating

RIDDL

Full Documentation

Is here: https://riddl.tech

Introduction

RIDDL, the Reactive Interface to Domain Definition Language, is a specification lanugage and tooling to help capture requirements and specify designs for the class of systems that can be designed with DDD and utilize a distributed, reactive cloud native architecture.

RIDDL allows subject matter experts, business analysts, and system architects to work at a higher level of abstraction than they would if they were coding directly in a programming language. RIDDL aims to relieve developers of the burden of maintaining infrastructural code through evolution of the system abstractions.

Important Documentation Sections

  • Introduction - answer the important initial questions
  • Concepts - provides a conceptual understanding of RIDDL before diving into the details
  • Guides - four guides for different kinds of RIDDL audiences.
  • riddlc - various ways to obtain the RIDDL compiler

Install With brew

TBD

Quickly Building On Your Computer

To use riddlc locally and be able to update it with new changes, use this approach:

  • git clone the latest content and change directory to that cloned repository
  • Put the .../riddl/riddlc/target/universal/stage/bin directory in your PATH variable
  • Run sbt stage to build the program
  • To update, run git pull from the riddl cloned repository directory and rerun the sbt stage command to rebuild.

This allows you to both make local changes and pull in changes from others to keep your local copy of riddlc up to date.

Usage

To get the most recent options, run riddlc help. That command will give you the syntax for doing various things with the riddl compiler (riddlc)

Version / Info

The riddlc compiler has two command, info and version that just print out information and the version number, respectively, and then exit.

Contributing

Contributions are very welcome!

If you see an issue that you'd like to see fixed, or want us to consider a change, the best way to make it happen is to help out by submitting a pull request implementing it. We welcome contributions from all, even if you are not yet familiar with RIDDL. We will endeavour to guide you through the process once you've submitted your PR.

Please refer to the CONTRIBUTING.md file for more details about the workflow, and general hints on how to prepare your pull request. You can also ask for clarifications or guidance in GitHub issues directly

The RIDDL family of repositories are owned by Ossum, Inc. and they require the use of a CLA (Contributor License Agreement). You can sign at that link or be prompted to do so when you submit your first Pull Request.