Skip to content
Snippets Groups Projects
Verified Commit 58166812 authored by Timm Fitschen's avatar Timm Fitschen
Browse files

DOC: update README

parent ac3fb460
No related branches found
No related tags found
No related merge requests found
Pipeline #47155 passed
......@@ -14,4 +14,5 @@ stages:
webui:build-test:
stage: test
script:
- npm install
- npm run build
# 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
# 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>
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment