inavac182 / uireact

Themed UI components to speed up react web development
https://uireact.io
2 stars 1 forks source link

Build and Deploy React Styled Components Next JS Turbo Pnpm TS

ATTENTION!!!

V3 is here, From Styles components to SCSS modules.

We moved away from styled-components to SCSS modules, so we can get all the benefits of server components in JS frameworks such as Remix and Next JS.

Issue: Move to SCSS Modules.

@UiReact.io icon

You should see our docs: uireact.io.

Quick set up ⚙️

If you are starting a brand new project you can run these 2 scripts which will generate a fully configured project:

Next Js

npx @uireact/create-next-app@latest

Remix

npx @uireact/create-remix-app@latest

If the project already exists and you want to add this library then you will have to manually set it up.

Manual set up 🛠️

  1. Install the main packages:

    npm i -S @uireact/foundation @uireact/view
  2. Wrap your app inside the UiView component:

import { ThemeColor } from '@uireact/foundation';
import { UiView } from '@uireact/view';

const App = ({ children }) => (
  <UiView selectedTheme={ThemeColor.dark}>
    {children}
  </UiView>
)
  1. Link the packages styles to your global styles files:
// In CSS: Update the route based on your project.
  @import url('../node_modules/@uireact/foundation/dist/index.css'); 

  // Include all packages styles
  @import url('../node_modules/@uireact/view/dist/index.css'); 

That's it... You are ready to start installing and using any component in this library 🫶

Contact ☎️

If you want to reach out to us these are our public social networks: