From 584841b0d379e1fb3396025c4b4ad7256c7aa89c Mon Sep 17 00:00:00 2001 From: lfjnascimento Date: Mon, 24 Jun 2024 16:57:41 -0300 Subject: [PATCH] feat: add the project README.md --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7a13b28 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# KernelCI Dashboard +The goal of this project is to create a new KernelCI Web Dashboard to replace +the existing one available at https://linux.kernelci.org/. +The new KernelCI Web Dashboard is a web application created to provide access +to static checks, build logs, boot logs and test results related to the Linux kernel +CI system. All that data will be provided by kcidb system from Linux +Foundation. + +# Repository +What we have as a repository is a monorepo containing the *dashboard* (the web application) and a *backend*. + +### Dashboard +A web app built with [React](https://react.dev/) + [Typescript](https://www.typescriptlang.org/), to see more information check the dashboard [README](dashboard/README.md). + +### Backend +A Python http server built with [Django](https://www.djangoproject.com/) + [DRF](https://www.django-rest-framework.org/), to see more information check the backend [README](/backend/README.md). \ No newline at end of file