Merge branch 'main' of github.com:utopia-os/utopia-ui

2025-12-13 07:46:10 +00:00 · 2024-10-23 11:29:42 +02:00 · 2024-10-23 11:29:42 +02:00 · 7265c2247d
commit 7265c2247d
parent 2a55a1a2c0 ecbb092f00
1 changed files with 97 additions and 33 deletions
--- a/README.md
+++ b/README.md
@ -10,7 +10,7 @@ Utopia UIs mission is to provide open source building blocks to create beautiful

 The building blocks are designed to allow different networks and communities to assemble their map and app for their specific needs and purpose.

-Utopia Game is the first app made with Utopia UI. It is an attempt to use gamification to get users to take action and make the map even more alive. Check it out at [utopia-game.org](https://utopia-game.org/) or see the code in the [repository](https://github.com/utopia-os/utopia-game)
+Utopia Game is one of the apps made with Utopia UI. It is an attempt to use gamification to get users to take action and make the map even more alive. Check it out at [utopia-game.org](https://utopia-game.org/) or see the code in the [repository](https://github.com/utopia-os/utopia-game)

 ## Features

@ -23,10 +23,102 @@ Utopia Game is the first app made with Utopia UI. It is an attempt to use gamifi

 ## Getting Started

+### Basic Map
+In this tutorial we learn how we create a basic React app with a Map component using [utopia-ui](https://github.com/utopia-os/utopia-ui) library.
+
+For this tutorial we use Vite to create an empty React app called "utopia-static-map"
+
+```shell
+npm create vite@latest utopia-static-map -- --template react
+```
+
+We open our new app in the terminal and install the [utopia-ui](https://github.com/utopia-os/utopia-ui) package
+
+```shell
+cd utopia-static-map
+npm install utopia-ui
+```
+
+We open our `src/App.jsx` and we replace the content with
+
+```jsx
+import { UtopiaMap } from "utopia-ui"
+
+function App() {
+  return (
+    <UtopiaMap center={[50.6, 9.5]} zoom={5} height='100dvh' width="100dvw">
+    </UtopiaMap>
+  )
+}
+
+export default App
+
+```
+
+Then we start the development server to check out the result in our browser:
+
+```shell
+npm run dev
+```
+
+And can open our first map app in the browser 🙂
+
+### Static Layers
+
+Now we add some static layer.
+
+First we put some sample data in a new file called `src/sample-data.js`
+
+```javascript
+export const places = [{
+    "id": 51,
+    "name": "Stadtgemüse",
+    "text": "Stadtgemüse Fulda ist eine Gemüsegärtnerei in Maberzell, die es sich zur Aufgabe gemacht hat, die Stadt und seine Bewohner:innen mit regionalem, frischem und natürlich angebautem Gemüse mittels Gemüsekisten zu versorgen. Es gibt also jede Woche, von Frühjahr bis Herbst, angepasst an die Saison eine Kiste mit schmackhaftem und frischem Gemüse für euch, welche ihr direkt vor Ort abholen könnt. \r\n\r\nhttps://stadtgemuese-fulda.de",
+    "position": { "type": "Point", "coordinates": [9.632435, 50.560342] },
+  },
+  {
+    "id": 166,
+    "name": "Weidendom",
+    "text": "free camping",
+    "position": { "type": "Point", "coordinates": [9.438793, 50.560112] },
+  }];
+  
+  export const events = [
+    {
+      "id": 423,
+      "name": "Hackathon",
+      "text": "still in progress",
+      "position": { "type": "Point", "coordinates": [10.5, 51.62] },
+      "start": "2022-03-25T12:00:00",
+      "end": "2022-05-12T12:00:00",
+    }
+  ]
+```
+
+We want to create two Layers. One we want to call *Places* and the other *Events*
+
+we import our sample data to the `src/App.jsx`
+
+```jsx
+import { events, places } from "./sample-data"
+```
+and than we create our two `<Layer>` inside of our `<UtopiaMap>` component
+```jsx
+    <UtopiaMap center={[50.6, 15.5]} zoom={5} height='100dvh' width="100dvw">
+      <Layer
+        name='events'
+        markerIcon='calendar'
+        markerShape='square'
+        markerDefaultColor='#700'
+        data={events} />
+      <Layer
+        name='places'
+        markerIcon='point'
+        markerShape='circle'
+        markerDefaultColor='#007'
+        data={places} />
+    </UtopiaMap>

-install via npm
-```bash
- npm install utopia-ui
 ```

 ## Map Component
@ -34,34 +126,6 @@ The map shows various Layers (like places, events, profiles ...) of Items at the

 Tags, colors and clusters help to retain the overview.

-use the Map UI Component
-```jsx
-import { UtopiaMap, Layer} from 'utopia-ui'
-
-    <UtopiaMap zoom={5} height='100dvh' width="100dvw">
-      <Layer
-        name='events'
-        menuIcon='CalendarIcon'
-        menuText='add new event'
-        menuColor='#f9a825'
-        markerIcon='calendar'
-        markerShape='square'
-        markerDefaultColor='#777'
-        data={events} />
-      <Layer
-        name='places'
-        menuIcon='MapPinIcon'
-        menuText='add new place'
-        menuColor='#2E7D32'
-        markerIcon='point'
-        markerShape='circle'
-        markerDefaultColor='#777'
-        data={places} />
-    </UtopiaMap>
-```
-You can find some Sample Data (places, events, tags) for test in the `SamleData/` folder
-
-

 ### Map Options

@ -90,4 +154,4 @@ You can find some Sample Data (places, events, tags) for test in the `SamleData/

 <a href="https://opencollective.com/utopia-project">
    <img width="300" src="https://opencollective.com/utopia-project/donate/button@2x.png?color=blue" />
-</a>
+</a>