|
| 1 | +# Delphi Web API |
| 2 | + |
| 3 | +The web API implementation for the Delphi platform. |
| 4 | + |
| 5 | +We are currently in pre-alpha state! There is no release and the code in |
| 6 | +this repository is purely experimental! |
| 7 | + |
| 8 | +|branch | status | codacy | |
| 9 | +| :---: | :---: | :---: | |
| 10 | +| master | [](https://travis-ci.org/delphi-hub/delphi-webapi) | [](https://www.codacy.com/app/delphi-hub/delphi-webapi?utm_source=github.com&utm_medium=referral&utm_content=delphi-hub/delphi-webapi&utm_campaign=Badge_Grade)| |
| 11 | +| develop | [](https://travis-ci.org/delphi-hub/delphi-webapi) | [](https://www.codacy.com/app/delphi-hub/delphi-webapi?branch=develop&utm_source=github.com&utm_medium=referral&utm_content=delphi-hub/delphi-webapi&utm_campaign=Badge_Grade) | |
| 12 | + |
| 13 | +## What is the Delphi Web API? |
| 14 | + |
| 15 | +It is the primary access point to the Delphi system. |
| 16 | + |
| 17 | +## How does it work? |
| 18 | + |
| 19 | +The Delphi Web API communicates with the underlying Elasticsearch database to provide access to data. |
| 20 | + |
| 21 | +## How can I use it? |
| 22 | + |
| 23 | +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. |
| 24 | + |
| 25 | +If you want to run your own infrastructure, you can start the web API |
| 26 | +``` |
| 27 | +sbt run |
| 28 | +``` |
| 29 | + |
| 30 | +It expects a running instance of elasticsearch on port 9200 on the same machine. |
| 31 | + |
| 32 | +## Community |
| 33 | + |
| 34 | +Feel welcome to join our chatroom on Gitter: [](https://gitter.im/delphi-hub/delphi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
| 35 | + |
| 36 | + |
| 37 | +## Contributing |
| 38 | + |
| 39 | +Contributions are *very* welcome! |
| 40 | + |
| 41 | +Before contributing, please read our [Code of Conduct](CODE_OF_CONDUCT.md). |
| 42 | + |
| 43 | +Refer to the [Contribution Guide](CONTRIBUTING.md) for details about the workflow. |
| 44 | +We use Pull Requests to collect contributions. Especially look out for "help wanted" issues |
| 45 | +[](https://github.com/delphi-hub/delphi-webapi/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22), |
| 46 | +but feel free to work on other issues as well. |
| 47 | +You can ask for clarification in the issues directly, or use our Gitter |
| 48 | +chat for a more interactive experience. |
| 49 | + |
| 50 | +[](https://github.com/delphi-hub/delphi-webapi/issues) |
| 51 | + |
| 52 | + |
| 53 | +## License |
| 54 | + |
| 55 | +The Delphi Web API is open source and available under Apache 2 License. |
| 56 | + |
| 57 | +[](https://github.com/delphi-hub/delphi-webapi/blob/master/LICENSE) |
0 commit comments