Skip to content

A design system built with Rails and ViewComponents, offering a modular architecture to create elegant, reusable, and maintainable user interfaces. ๐Ÿš€

Notifications You must be signed in to change notification settings

pierre-jezegou/rails-design-system

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

85 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Rails Design System

A Rails project with ViewComponents to build modular and maintainable user interfaces. This repository provides a foundation for creating web applications with reusable design patterns.

โœจ Features

  • ViewComponents: Build reusable UI components with encapsulated logic and templates.
  • Modular System: Add and customize components easily to suit your application's needs.

๐Ÿš€ Getting Started

Installation Steps

  1. Clone this repository:

    git clone https://github.com/pierre-jezegou/rails-design-system.git
    cd rails-design-system
  2. Install Ruby dependencies:

    bundle install
  3. Start the development server:

    bin/rails server

Visit your application at http://localhost:3000. The Lookbook web interface is at http://localhost:3000/lookbook

๐Ÿ›  Using ViewComponents

Add new components in the app/components directory. Example:

  1. Generate a component:

    bin/rails generate component Navigation
  2. Define the component's behavior in app/components/navigation_component.rb and its template in app/components/navigation_component.html.erb or directly in component definition with erb_template

  3. Use the component in views:

    <%= render(NavigationComponent.new(title: "My Navigation")) %>

๐Ÿ›ก License

This project is licensed under the ???.

About

A design system built with Rails and ViewComponents, offering a modular architecture to create elegant, reusable, and maintainable user interfaces. ๐Ÿš€

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published