ClickSphere API is a middleware application that acts as a bridge between the ClickHouse database and other applications. It is developed using .NET 9 and provides a RESTful interface for querying the database. Compared to the standard HTTP interface, it offers higher level procedures for querying ClickHouse. This API enables seamless integration and interaction with the ClickSphere database in other applications, allowing authenticated users to retrieve data and perform various operations.
Please note that this API is not feature complete and still in development and therefore should not be used in productive environments.
To install and run the ClickSphere_API application, follow these steps:
- Clone the repository:
git clone https://github.com/MrDoe/ClickSphere_API.git - Navigate to the project directory:
cd ClickSphere_API - Install dependencies:
dotnet restore - Build the project:
dotnet build - Edit the configuration file
appsettings.jsonto configure your ClickHouse server address, port, user and default database. - Execute
dotnet user-secrets initanddotnet user-secrets set "ClickHouse:Password" [YourClickHousePassword]. - Run the application:
dotnet run
To use the ClickSphere_API application, follow these steps:
- Make sure the ClickHouse server and ClickSphere_API is running.
- Send HTTP requests to the appropriate endpoints to interact with ClickSphere (see the Tests folder for examples).
Contributions are welcome! If you would like to contribute to the ClickSphere API project, please follow these guidelines:
- Fork the repository.
- Create a new branch:
git checkout -b my-feature - Make your changes and commit them:
git commit -m 'Add some feature' - Push to the branch:
git push origin my-feature - Submit a pull request.
This project is licensed under the MIT License.
If you have any questions or suggestions regarding the ClickSphere API application, please contact Christoph Döllinger at christoph.doellinger@med.uni-heidelberg.de.