hr-react-ui

🛫 HotelRunner Design System

Folder Structure

🛡️ Bulletproof React

Development

📚 Storybook

🐜 Ant Design

⚡️ Vite

🤖 TypeScript

💡 Plop

📦 Yarn

📦 Prettier

📦 Eslint

📦 Husky

📦 Install the packages

In this template react@18.2.0 is being used and it might cause some peer dependency mismatches among the template dependencies If you prefer to use npm, you might need to call npm i --legacy-peer-deps to ignore resolution errors

• To use the design system, you should use the HotelRunnerProvider and HotelRunnerDesignProvider components.
• HotelRunnerProvider is a context provider for the design system. It provides the theme and the language context to the design system.
• HotelRunnerDesignProvider is a context provider for the design system. It provides the design system components to the application.

:warning: You should use the HotelRunnerDesignProvider under the HotelRunnerProvider.

⚡️ Start the development server

yarn dev

⚡️ Start the test server

yarn dev:test

⚡️ For Storybook

yarn storybook

📝 Generate a new component

yarn generate component
# it will create a new component in the components folder

🚚 Build for production

yarn build
# it will create a dist folder and tgz file and set the version in the test-project package.json
# After that you can test it with `yarn dev:test`

yarn build-only
# if you want to get only build dist folder use: