Difference between revisions of "Nicegui widgets/Tutorial"
(→README) |
|||
| Line 11: | Line 11: | ||
== README == | == README == | ||
| + | A GitHub README is a document that introduces and explains a project hosted on GitHub, providing essential information such as its purpose, how to install and use it, and its features. It is important because it serves as the first point of contact for anyone encountering the project, helping them understand what the project is about and how to engage with it. | ||
| + | |||
The [https://raw.githubusercontent.com/WolfgangFahl/ConferenceCorpus/main/README.md README] consists of | The [https://raw.githubusercontent.com/WolfgangFahl/ConferenceCorpus/main/README.md README] consists of | ||
* header | * header | ||
* badges | * badges | ||
| + | * link to demo | ||
| + | * example API calls | ||
* links to documentation | * links to documentation | ||
| − | |||
* authors list | * authors list | ||
| + | === README screenshot as of start of migration === | ||
| + | [[File:ccReadme2023-11-18.jpg|400px]] | ||
Revision as of 08:13, 18 November 2023
Example Usecase
This tutorial uses the ConferenceCorpus as it's usecase. As part of my research for the ConfIDent Project i am gathering metadata for scientific events from different datasources. There has been a lack of a proper frontend for the past few years although there have been several attempts to create a webserver and RESTFul services e.g. with
As of 2023-11 the project is now migrated to nicegui using the nicegui widgets (demo)
Setting up the project
The project is on github see ConferenceCorpus
README
A GitHub README is a document that introduces and explains a project hosted on GitHub, providing essential information such as its purpose, how to install and use it, and its features. It is important because it serves as the first point of contact for anyone encountering the project, helping them understand what the project is about and how to engage with it.
The README consists of
- header
- badges
- link to demo
- example API calls
- links to documentation
- authors list
README screenshot as of start of migration
