From 581668129030314eb8e2459574e728c7087471bb Mon Sep 17 00:00:00 2001
From: Timm Fitschen <t.fitschen@indiscale.com>
Date: Fri, 9 Feb 2024 12:37:31 +0100
Subject: [PATCH] DOC: update README
---
.gitlab-ci.yml | 1 +
README.MD | 49 -------------------------------------------------
README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 45 insertions(+), 49 deletions(-)
delete mode 100644 README.MD
create mode 100644 README.md
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 887a823..37e7e57 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -14,4 +14,5 @@ stages:
webui:build-test:
stage: test
script:
+ - npm install
- npm run build
diff --git a/README.MD b/README.MD
deleted file mode 100644
index 8ccae29..0000000
--- a/README.MD
+++ /dev/null
@@ -1,49 +0,0 @@
-# fdo-manager-webui-refine
-
-<div align="center" style="margin: 30px;">
- <a href="https://refine.dev">
- <img alt="refine logo" src="https://refine.ams3.cdn.digitaloceanspaces.com/readme/refine-readme-banner.png">
- </a>
-</div>
-<br/>
-
-This [Refine](https://github.com/refinedev/refine) project was generated with [create refine-app](https://github.com/refinedev/refine/tree/master/packages/create-refine-app).
-
-## Getting Started
-
-A React Framework for building internal tools, admin panels, dashboards & B2B apps with unmatched flexibility ✨
-
-Refine's hooks and components simplifies the development process and eliminates the repetitive tasks by providing industry-standard solutions for crucial aspects of a project, including authentication, access control, routing, networking, state management, and i18n.
-
-## Available Scripts
-
-### Running the development server.
-
-```bash
- npm run dev
-```
-
-### Building for production.
-
-```bash
- npm run build
-```
-
-### Running the production server.
-
-```bash
- npm run start
-```
-
-## Learn More
-
-To learn more about **Refine**, please check out the [Documentation](https://refine.dev/docs)
-
-- **REST Data Provider** [Docs](https://refine.dev/docs/core/providers/data-provider/#overview)
-- **Material UI** [Docs](https://refine.dev/docs/ui-frameworks/mui/tutorial/)
-- **Custom Auth Provider** [Docs](https://refine.dev/docs/core/providers/auth-provider/)
-- **i18n** [Docs](https://refine.dev/docs/core/providers/i18n-provider/)
-
-## License
-
-MIT
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..18eb226
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# FDO Manager Web-based User Interface
+
+**This is WIP - don't use it unless you want to break things.**
+
+## Setup
+
+Setup the run time environment with
+
+```bash
+npm install
+```
+
+## Run
+
+### Running the development server.
+
+```bash
+ npm run dev
+```
+
+### Building for production.
+
+```bash
+ npm run build
+```
+
+### Running the production server.
+
+```bash
+ npm run start
+```
+
+# Contact
+
+* (Lead) Timm Fitschen <t.fitschen@indiscale.com>
+
+# License
+
+AGPL 3.0 or later. <https://www.gnu.org/licenses/agpl-3.0.en.html>
+
+# Copyright
+
+* Copyright (C) 2024 Timm Fitschen <t.fitschen@indiscale.com>
+* Copyright (C) 2024 IndiScale GmbH <info@indiscale.com>
--
GitLab