close
Skip to main content

Documentation Index

Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt

Use this file to discover all available pages before exploring further.

This tutorial walks you through creating a complete Spree feature from scratch, covering models, Admin dashboard, Store API, and TypeScript SDK integration. You will also learn how to extend core Spree features to connect them with your new feature. By the end, you’ll understand how to add new manageable features to the Spree platform.

​
Overview

To fully implement a new feature, you will typically create the following components:
  • Database model
  • Admin Dashboard controllers and views
  • Store API endpoints and serializers
  • TypeScript SDK integration
  • Automated tests

​
Tutorial Sections

1. Model

Create the Brand model with migrations, validations, and associations

2. Admin Dashboard

Build admin interface for managing brands

3. Rich Text

Add rich text descriptions using Action Text

4. File Uploads

Add logo images with Active Storage

5. Extending Core Models

Connect Brands to Products using associations

6. Store API

Expose Brands through the Store API with serializers, controllers, and routes

7. SDK

Consume Brand endpoints from TypeScript using the SDK

8. Testing

Write automated tests for your feature

​
Example: Building a Brands Feature

In this guide we will create a complete “Brands” feature that allows admins to manage Product brands.