fix(docu): extending examples (#197)

* Create README.md

* Update README.md

* Update examples/README.md

Co-authored-by: mahula <lenzmath@posteo.de>

---------

Co-authored-by: mahula <lenzmath@posteo.de>
This commit is contained in:
Anton Tranelis 2025-04-17 12:13:30 +01:00 committed by GitHub
parent 1d70cd4f3e
commit 3bd22259f9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

32
examples/README.md Normal file
View File

@ -0,0 +1,32 @@
# Examples
Here is a collection of executable examples. Building on each other, they show the features available in the Utipia-ui library.
You can run them and try them out locally in the browser.
## Running the examples
These examples depend on the `/dist` of the root project. You have to run `npm run build` in the root project before you can run the examples:
Using the example [3 - Tags](./3-tags):
```sh
# in root directory install and build the library
npm install
npm run build
# change to specific example directory
cd ./examples/3-tags
# install and run the example code
npm install && npm run dev
# call up the running example in the browser at http://localhost:5173/
## Roadmap
- [x] Basic Map
- [x] Static Layers
- [x] Tags Custom Views & Forms
- [ ] APIs Integration
- [ ] Permissions
- [ ] Custom Views & Forms
- [ ] AppShell