Rimelight Components

A Nuxt module with components and utilities used internally at Rimelight Entertainment.

[!WARNING] This module is in early development and may contain placeholders and not strictly adhere to best practices.

• Documentation
• Playground
• Release Notes

Features

• Block-based Page Rendering

Setup

Install the package from npm:

bun add rimelight-components

Add the module to your nuxt.config.js:

export default defineNuxtConfig({
  modules: ['rimelight-components']
})

Learn more in the installation guide.

Contribution

Thank you for considering contributing to Rimelight Components. Here are a few ways you can get involved:

• Reporting Bugs: If you come across any bugs or issues, please check out the reporting bugs guide to learn how to submit a bug report.
• Suggestions: Have any thoughts to enhance Rimelight Components? We'd love to hear them! Check out the contribution guide to share your suggestions.

Local Development

# Install dependencies
bun install

# Generate type stubs
bun dev:prepare

# Develop with the playground
bun dev

# Build the playground
bun dev:build

# Run Typecheck
bun typecheck

# Run Oxlint
bun lint

# Run Prettier
bun format

# Run Vitest
npm run test

# Release new version
bun release

Learn more in the development guide.

Sponshorship

License

Licensed under the MIT license.