Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 1.82 KB

getting-started.md

File metadata and controls

80 lines (51 loc) · 1.82 KB

Getting Started with Murrieta Design System

Welcome to the Murrieta Design System! This guide will help you set up and start using Murrieta to build cohesive and scalable user interfaces.

Prerequisites

Before you begin, ensure you have the following installed:

  • Bun (a fast JavaScript runtime and package manager)
  • Node.js (optional, for compatibility purposes)
  • A code editor, such as VS Code

Note: Murrieta uses Turborepo to manage its monorepo structure, with Bun enabling fast dependency management and script execution.

Installation

Murrieta is published to npm under the organization @murrieta. You can install it in your project as follows:

Using npm

npm install @murrieta/ui

Using yarn

yarn add @murrieta/ui

Using bun

bun add @murrieta/ui

Using Murrieta Components

After installing, you can use Murrieta components in your React project:

import { Button } from '@murrieta/ui';

const App = () => (
  <Button variant="primary">Click Me</Button>
);
export default App;

Running Locally

To explore or contribute to the Murrieta Design System, clone the repository and run it locally: 1.Clone the Repository:

git clone https://github.com/etnlbck/murrieta-design-system.git
cd murrieta-design-system

2.Install Dependencies:

Using Bun:

bun install

3.Start the Development Server:

Run the Storybook server to preview and develop components:

bun run dev

4.View in Your Browser:

Open http://localhost:6006/ to explore and interact with Murrieta components.

That’s it! You’re now ready to use the Murrieta Design System in your projects. For more information, check out the Murrieta GitHub repository.