Skip to content
Lorenzo Cavazzi edited this page Feb 20, 2025 · 6 revisions

Renku UI documentation

Welcome to the Renku UI wiki! 👋

This page contains information about the Renku UI repository, which is part of the Renku project.
It requires a full Renkulab deployment to work correctly. Check out our public instance at renkulab.io .

🏛️ Architecture

The Renku UI is a web interface written in TypeScript (mind some JavaScript legacy components for Renku 1.0) and based on React. We use Bootstrap as our frontend framework, Redux Toolkit (based on Redux) for the state management, and Cypress for test automation.

We still maintain a backend-for-frontend component based on Express that will be phased out in the future.

🧑‍💻 Contribute

🚧 TODO

We should make a separate contribution guidelines file

We welcome contributions and feedback from everyone! Our code is licensed as Apache 2.0.

Feedback and bug reports

If you wish to provide feedback, signal bugs, or suggest features, please start a new discussion in the Discussions section. There is no poor question nor useless bug report! A maintainer will care about opening issues with all the details so that developers can work on them.

Develop

You can start developing with just an npm install command! Please have a look at the Develop page for additional details.

👥 Who we are

As part of the Renku project, Renku UI is backed by the Swiss Data Science Center, a joint venture between Swiss universities. We care about the open source community and welcome (and encourage!) any contribution.