Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
damianlegawiec committed Feb 25, 2025
1 parent 59adeb5 commit e402126
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,36 @@ You can quickly use Render to deploy a new Spree Starter instance.

## Local Installation

### Clone the repository

```bash
git clone https://github.com/spree/spree_starter.git
cd spree_starter
```

### Prerequisites

Make sure you have the following installed:
* Docker with Docker Compose - [installation instructions](https://docs.docker.com/get-docker/)
* Ruby 3.3 - [installation instructions](https://www.ruby-lang.org/en/documentation/installation/)
* Vips - [installation instructions](https://libvips.github.io/libvips/install.html)

On MacOS you can install the dependencies using [Homebrew package manager](https://brew.sh/):
On MacOS you can install the dependencies using [Homebrew package manager](https://brew.sh/) with [asdf](https://asdf-vm.com/) to manage the Ruby version:

```bash
brew install vips ruby@3.3
brew install vips asdf
asdf plugin add ruby
asdf install ruby
```

### Setup the application

Start docker containers with the following command:

```bash
docker compose up -d
```

Run the following command to install the dependencies and prepare the database:

```bash
Expand Down

0 comments on commit e402126

Please sign in to comment.