README.md

Delphi Web API

The web API implementation for the Delphi platform.

We are currently in pre-alpha state! There is no release and the code in this repository is purely experimental!

branch	status	codacy	snyk
master
develop

What is the Delphi Web API?

It is the primary access point to the Delphi system.

How does it work?

The Delphi Web API communicates with the underlying Elasticsearch database to provide access to data.

How can I use it?

If you just wish to query the results, maybe the public instance at https://delphi.cs.uni-paderborn.de is the right choice for you.

If you want to run your own infrastructure, you can start the web API

sbt run

It expects a running instance of elasticsearch on port 9200 on the same machine.

Community

Feel welcome to join our chatroom on Gitter:

Contributing

Contributions are very welcome!

Before contributing, please read our Code of Conduct.

Refer to the Contribution Guide for details about the workflow. We use Pull Requests to collect contributions. Especially look out for "help wanted" issues , but feel free to work on other issues as well. You can ask for clarification in the issues directly, or use our Gitter chat for a more interactive experience.

License

The Delphi Web API is open source and available under Apache 2 License.