diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..fdd0f7dc --- /dev/null +++ b/.gitignore @@ -0,0 +1,91 @@ +# See http://help.github.com/ignore-files/ for more about ignoring files. + +# compiled output +/dist +/tmp +/out-tsc + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Bower dependency directory (https://bower.io/) +bower_components + +# node-waf configuration +.lock-wscript + +# IDEs and editors +.idea +.project +.classpath +.c9/ +*.launch +.settings/ +*.sublime-workspace + +# IDE - VSCode +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json + +# misc +.sass-cache +connect.lock +typings + +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* + + +# Dependency directories +node_modules/ +jspm_packages/ + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# dotenv environment variables file +.env + +# next.js build output +.next + +# Lerna +lerna-debug.log + +# System Files +.DS_Store +Thumbs.db \ No newline at end of file diff --git a/README.md b/README.md index 8cb550af..2c161056 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,19 @@ # Utopia UI -Reuseable React Components to build mapping apps for all kinds of communities +Reuseable React Components to build mapping apps for all kinds of communities with focus of real life action, local connection and positiv impact. + +Check [utopia-os.org](https://utopia-os.org) for more information + +*This Library is in early alpha stage. You are very welcome to participate in the development* + +*A Django-based Proof of Concept can be found @ [new.docutopia.de](https://new.docutopia.de). This map can be edited freely you can register to create an account and place them on the map. The project is no longer maintained.* + +Utopia UI is a fully new approach to create a Open Source Library of JavaScript Components which should fit the needs of many different projects and communities. -## Getting Started +## Map UI Component +Map UI is a JavaScript Map Library to create nice and easy to use Maps + +### Getting Started install via npm ``` @@ -21,10 +32,27 @@ use the Map UI Component ``` -## Options +### Options Option | Type | Default | Description --- | --- | --- | --- - height | x | | - width | x | | \ No newline at end of file + height | string | - | height of the map + width | string | - | width of the map + + + ## Coming Soon + + * Profile UI Component + * Market UI Component + * Calendar UI Component + * Friends + * Groups + * Tags & Colors + * Gamification Elements + +## Join the community + + *We are looking for Web Developer, UX Designer, Community Manager, Visionaries, Artists, etc. who like to support this Vision.* + +[https://t.me/utopiaOS](https://t.me/utopiaOS) \ No newline at end of file