From 3bd22259f9d9bc183cced2a3f6dd32ecafa6d4c8 Mon Sep 17 00:00:00 2001 From: Anton Tranelis <31516529+antontranelis@users.noreply.github.com> Date: Thu, 17 Apr 2025 12:13:30 +0100 Subject: [PATCH] fix(docu): extending examples (#197) * Create README.md * Update README.md * Update examples/README.md Co-authored-by: mahula --------- Co-authored-by: mahula --- examples/README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 examples/README.md diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 00000000..43eb75f0 --- /dev/null +++ b/examples/README.md @@ -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