@g-loot/css-framework

A CSS Framework built on Tailwind CSS to bring consistency and speed to G-Loot products.

---

Documentation

For full documentation, visit gloot-framework.netlify.app.

Using the framework

1. Install tailwindcss

Install tailwindcss and its peer dependencies via npm.

npm install -D tailwindcss postcss autoprefixer

2. Install the framework

Install @g-loot/css-framework via npm.

npm install @g-loot/css-framework

3. Import the css

Import the Framework CSS into your project stylesheet.

@import '@g-loot/css-framework/styles/globals.css';

4. Adapt webpack config.

Add postcss-loader to webpack.config.js.

module: {
  rules: [
    {
      test: /\.(css)$/,
      use: ['style-loader', 'css-loader', 'postcss-loader'],
    }
  ]
}

5. Import and adapt tailwind config.

Import the framework config into your project tailwind.config.js and indicate which files Tailwind should scan.

const tailwindConfig = require('@g-loot/css-framework/tailwind.config');
module.exports = {
  ...tailwindConfig,
  content: [
    "./pages/*.{js,ts,jsx,tsx,json}",
  ],
};

Example repository

Check this example setup of the G-Loot Framework and Tailwind CSS on React (webpack).

That's it!

Your projects can now consume the G-Loot theme and components. ✨