diff --git a/README.md b/README.md index e67815f8..6432d47d 100644 --- a/README.md +++ b/README.md @@ -6,19 +6,6 @@ Utopia Map is made for networks and initiatives that aim to connect people in re **Utopia Map** is based on our library **[Utopia UI](https://github.com/utopia-map/lib)**. -## 📋 Table of Contents - -- [Key Features](#key-features) -- [Architecture](#architecture) -- [Core Concepts](#core-concepts) -- [Tech Stack](#tech-stack) -- [Getting Started](#getting-started) -- [Project Structure](#project-structure) -- [Development](#development) -- [Deployment Options](#deployment-options) -- [Examples](#examples) -- [Support](#support) - ## ✨ Key Features - **Interactive Map**: The core feature is an intuitive geographical map where users can add, edit, and manage items like members, activities, and resources. Each map instance has its own identity, users, and unique configuration. @@ -169,8 +156,8 @@ npm run docs:generate # Generate documentation ### Code Quality - **ESLint** & **Prettier** for code formatting - **TypeScript** strict mode enabled -- Comprehensive test coverage with Vitest and Cypress -- Documentation with TypeDoc +- Testing with **Vitest** and **Cypress** +- Documentation with **TypeDoc** ## 🌐 Deployment Options @@ -180,42 +167,13 @@ A hosted solution with regular updates and support for easy onboarding and maint ### Self-Hosted Deploy on your own infrastructure to retain full control and customization: -1. **Frontend**: Can be deployed to any static hosting service (Netlify, Vercel, etc.) -2. **Backend**: Deploy Directus using Docker or any Node.js hosting -3. **Environment Variables**: Configure API endpoints and authentication - ## 📚 Examples The library includes three example implementations in `/lib/examples/`: -1. **Basic Map** - Simple map implementation -2. **Static Layers** - Map with predefined layers -3. **Tags** - Implementation with tagging system - -## 🎮 Component Library Features - -### Map Components -- Interactive map with Leaflet -- Clustered markers -- Custom marker icons -- Layer management -- Search functionality -- Location controls - -### UI Components -- Responsive app shell -- Modal system -- Form inputs with validation -- Rich text editor -- Image upload with compression -- Date/time pickers - -### Profile System -- Multiple profile templates (Simple, Onepager, Tabs, Flex) -- Gallery management -- Social sharing -- Relation management -- Crowdfunding integration +1. **[Basic Map](https://github.com/utopia-os/utopia-map/tree/main/lib/examples/1-basic-map)** - Simple map implementation +2. **[Static Layers](https://github.com/utopia-os/utopia-map/tree/main/lib/examples/2-static-layers)** - Map with predefined layers +3. **[Tags](https://github.com/utopia-os/utopia-map/tree/main/lib/examples/3-tags)** - Implementation with tagging system ## 🌱 Get your Map!