mirror of
https://github.com/utopia-os/utopia-ui.git
synced 2025-12-13 07:46:10 +00:00
93 lines
3.8 KiB
Markdown
93 lines
3.8 KiB
Markdown
# Utopia UI [](https://www.npmjs.com/package/utopia-ui)
|
|
**UI Framework for Real-Life-Networking-Apps**
|
|
|
|
*Real change happens in real life when we meet in person and connect as local communities manifesting their ideas with the earth. When we help each other to step out of capitalism and individualism and start building common infrastructure to meet human needs in harmony with Mother Earth.*
|
|
|
|
*That is why Utopia UI exists. It is a UI kit for minimalist, fast, intuitive and mobile-first map apps, as a tool for local connection and decentralised networking. It can work with any backend or p2p database and any kind of data structure.*
|
|
|
|
## Mission
|
|
Utopia UIs mission is to provide open source building blocks to create beautiful applications with a focus on real life impact, local communities and gamification.
|
|
|
|
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)
|
|
|
|
## Features
|
|
|
|
* Interactive Component Map with customizable Layers (like Projects, Event, People)
|
|
* Flexible API-Interface to make it work with every backend or p2p database
|
|
* Create, Update, Delete Items
|
|
* User Authentification API-Interface
|
|
* User Profiles
|
|
* App Shell
|
|
|
|
## Getting Started
|
|
|
|
|
|
install via npm
|
|
```bash
|
|
npm install utopia-ui
|
|
```
|
|
|
|
## Map Component
|
|
The map shows various Layers (like places, events, profiles ...) of Items at their respective position whith nice and informative Popup and Profiles.
|
|
|
|
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
|
|
|
|
Option | Type | Default | Required | Description
|
|
--- | --- | --- | --- | ---
|
|
`height` | `string` |`'400px'` | No | height of the map
|
|
`width` | `string` |`'100vw'` | No | width of the map
|
|
`center` | `LatLng` |`[50.6, 9.5]` | No | initial map position
|
|
`zoom` | `number` |`10` | No | initial zoom level
|
|
|
|
### Layer Options
|
|
|
|
Option | Type | Default | Required | Description
|
|
--- | --- | --- | --- | ---
|
|
| ... | | | |
|
|
|
|
## Join the community
|
|
|
|
*This Library is in alpha stage. You are very welcome to participate in the development*
|
|
|
|
*We are looking for Web Developer, UX Designer, Community Manager, Visionaries, Artists, etc. who like to support this Vision.*
|
|
|
|
[https://t.me/UtopiaMap](https://t.me/UtopiaMap)
|
|
|
|
## Support us
|
|
|
|
<a href="https://opencollective.com/utopia-project">
|
|
<img width="300" src="https://opencollective.com/utopia-project/donate/button@2x.png?color=blue" />
|
|
</a> |