Skip to content

Commit a0dd247

Browse files
sbabicStefano Babic
authored andcommitted
Enhance README
Signed-off-by: Stefano Babic <sbabic@nabladev.com>
1 parent 9a5f0e5 commit a0dd247

1 file changed

Lines changed: 27 additions & 3 deletions

File tree

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,30 @@
1-
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
1+
HawkbitGUI - modern GUI for the Hawkbit Server
2+
==============================================
3+
4+
This is a GUI for Eclipse Hawkbit [hawkBit](https://github.com/eclipse-hawkbit/hawkbit), an open-source
5+
backend platform for managing and deploying software and firmware updates to various connected devices.
6+
This project wants to solve the issue of missing GUI as reported in [#1376](https://github.com/eclipse-hawkbit/hawkbit/issues/1376).
7+
It is goal to resolve the strong dependencies, and HawkbitGUI does not need at all to be linked with
8+
Hawkbit's code. It uses the REST API provided by Hawkbit, and it can be installed on any server.
9+
10+
Focus of this project is:
11+
HawkbitGUI claims to solve some issues in Hawkbit:
12+
13+
- remove dependencies from the Hawkbit Server.
14+
It is a separate project, built outside Hawkbit's Java environment,
15+
and it just uses the REST API provided by Hawkbit.
16+
- GUI and server do not need to run on the same server. GUI can be configured with which server must be connected
17+
design easier to change, even if it currently resembles the previous GUI.
18+
- better UX
19+
20+
## License
21+
22+
This Software is licensed under GPLv3.
223

324
## Getting Started
425

26+
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
27+
528
First, run the development server:
629

730
```bash
@@ -16,6 +39,7 @@ bun dev
1639

1740
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
1841

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
42+
## Configuration
43+
44+
You have to set in `.env` the URL for the Hawkbit Server by setting the `NEXT_PUBLIC_HAWKBIT_API_URL` variable.
2045

21-
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.

0 commit comments

Comments
 (0)