docs: add README.md guide for design system (#1)

docs: add README.md guide for design system

.vscode/settings.json

@@ -0,0 +1,24 @@
+{
+  "eslint.experimental.useFlatConfig": true,
+
+  "prettier.enable": false,
+  "editor.formatOnSave": false,
+
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.organizeImports": "never"
+  },
+
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact",
+    "html",
+    "markdown",
+    "json",
+    "jsonc",
+    "yaml",
+    "toml"
+  ]
+}

README.md

@@ -1 +1,98 @@
-# desing-system
+# Desing System
+
+<img src="./resources/OpenLand.jpeg" alt="Open Land logo" align="right"  width="100">
+
+This is the source code for https://desing-system.dev by Open Land
+
+<br>
+
+## Project Information
+
+**Goals**
+
+- Open Sources
+- Improve the design
+- Easy to use
+
+## Getting Started
+
+<img src="./resources/preview.png" alt="Open Land logo" align="right"  width="300">
+This design system is totally easy to use with the aim of facilitating upcoming new projects. The design system is a challenge for our team. You can gladly contribute and guide us with ideas to improve.
+
+<br>
+<br>
+<br>
+
+## Components
+
+_General_
+
+- [ ] Button
+- [ ] Typography
+- [ ] Icon
+- [ ] Image (work in progress)
+
+_Data Input_
+
+- [ ] Input
+- [ ] InputNumber
+- [ ] Select (custom select wip)
+- [ ] Checkbox
+- [ ] Radio
+- [ ] Toggle
+- [ ] Upload
+- [ ] Slider
+- [ ] Date picker
+- [ ] Time picker
+- [ ] Form
+
+_Layout_
+
+- [ ] Divider
+- [ ] Space (Flex)
+
+_Display_
+
+- [ ] Card
+- [ ] Avatar
+- [ ] Accordion
+- [ ] Alert
+- [ ] Badge
+- [ ] Menu
+- [ ] Tooltips
+- [ ] Tables
+- [ ] Code block
+
+_Navigation_
+
+- [ ] Tabs
+- [ ] Breadcrumb
+- [ ] Dropdown
+- [ ] Menu
+- [ ] Page Header
+- [ ] Sidebar
+- [ ] Flyout menu
+- [ ] Steps
+
+_Overlay_
+
+- [ ] Modal
+- [ ] Context Menu
+- [ ] Drawer / SidePanel
+- [ ] Toast messages / Notification
+- [ ] Progress
+- [ ] Feeds / Timeline
+
+## Documentation
+
+If you want to know more about this design system visit
+
+- https://design-system/docs/
+
+## License
+
+Design System is licensed under either of
+
+- MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)
+
+We would be keen to hear any feedback on this project.

eslint.config.ts

@@ -0,0 +1,6 @@
+import eslint from '@antfu/eslint-config'
+
+export default eslint({
+  formatters: true,
+  typescript: true,
+})

package.json

@@ -0,0 +1,20 @@
+{
+  "name": "desing-system",
+  "type": "module",
+  "version": "1.0.0",
+  "description": "",
+  "author": "",
+  "license": "MIT",
+  "keywords": [],
+  "main": "index.js",
+  "scripts": {
+    "lint": "eslint --fix"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "2.8.3",
+    "@types/node": "20.11.28",
+    "eslint": "8.57.0",
+    "eslint-plugin-format": "^0.1.0",
+    "typescript": "5.4.2"
+  }
+}