geoiq-frontend-ui-kit
v1.4.0
Published
This project is a UI kit for GeoIQ's frontend. It's built with React, TypeScript, and Vite.
Downloads
463
Maintainers
Readme
GeoIQ Frontend UI Kit
This project is a UI kit for GeoIQ's frontend. It's built with React, TypeScript, and Vite.
Features
- React for building user interfaces
- TypeScript for static typing
- Vite for a fast development server and build tool
- PostCSS for processing CSS
- Storybook for developing components in isolation
Scripts
Here are the npm scripts you can run: (Dont for get to login before publishing run npm login
)
npm run dev
: Starts the Vite development servernpm run build
: Builds the project for productionnpm run build:styles
: Builds the styles and copies theui-kit-preset.js
file to thedist
foldernpm run lint
: Lints the project with ESLintnpm run preview
: Previews the production buildnpm run watch-build
: Watches thesrc
folder and builds the project when files changenpm run storybook
: Starts the Storybook development servernpm run build-storybook
: Builds Storybook for productionnpm run npm-publish
: Publishes the package, Dont forget to increment version number manuallynpm run npm-publish:patch
: Increments the patch version, builds the project, and publishes it to the npm registrynpm run npm-publish:minor
: Increments the minor version, builds the project, and publishes it to the npm registrynpm run npm-publish:major
: Increments the major version, builds the project, and publishes it to the npm registry
Getting Started
- import
ui-kit-preset.js
fromdist
folder and add it to your tailwind config file in the presets. - start importing the components from
geoiq-frontend-ui-kit
.
Components
This UI kit includes the following components:
- Button
- Input
- Checkbox
- Radio
- Dropdown
- Modal
- Tooltip
- Table
Each component has its own props for customization. Please refer to the individual component documentation for more details.
License
This project is licensed under the MIT License.