Spree Commerce

https://spreecommerce.org/docs/developer/getting-started/quickstart

Admin

Spree Commerce is an open-source e-commerce platform and Ruby on Rails framework for building and...

Tokens:592

Snippets:10

Trust Score:9.8

Update:5 months ago

Show doc for...

Tokens:

Raw

### Start Spree Development Server

Source: https://spreecommerce.org/docs/developer/getting-started/quickstart

Run this command to start the Spree development server. Ensure you are in the application's root directory.

```bash
bin/dev
```

--------------------------------

### Create Spree App with CLI

Source: https://spreecommerce.org/docs/developer/getting-started/quickstart

Use this command to quickly scaffold a new Spree project. It offers options for a full-stack application with a Next.js storefront or a backend-only setup. Ensure Node.js 20+ and Docker are installed.

```bash
npx create-spree-app@latest my-store
```

--------------------------------

### Install Rails Gem

Source: https://spreecommerce.org/docs/developer/getting-started/quickstart

Install the Rails gem as a prerequisite for manual Spree installation. This command is part of the setup for developers who prefer manual control over their Spree application.

```bash
gem install rails
```

--------------------------------

### Create New Spree Application (Manual)

Source: https://spreecommerce.org/docs/developer/getting-started/quickstart

Scaffold a new Spree application using the official Rails template. This command is for manual installation and allows specifying the database type.

```bash
rails new my_store -m https://raw.githubusercontent.com/spree/spree/main/spree/template.rb
```

```bash
rails new my_store -d postgresql -m https://raw.githubusercontent.com/spree/spree/main/spree/template.rb
```

```bash
rails new my_store -d mysql -m https://raw.githubusercontent.com/spree/spree/main/spree/template.rb
```

--------------------------------

### Load Spree Sample Data

Source: https://spreecommerce.org/docs/developer/getting-started/quickstart

Execute this command to populate your Spree application with sample data, including products and categories. This is useful for testing and development.

```bash
bin/rails spree_sample:load
```

--------------------------------

### Navigate to Spree Application Directory

Source: https://spreecommerce.org/docs/developer/getting-started/quickstart

Change the current directory to your newly created Spree application. This is a standard step after scaffolding a new Rails project.

```bash
cd my_store
```

Tokens:

Raw