https://github.com/spree/spree_cli
https://github.com/spree/spree_cli
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/spree/spree_cli
- Owner: spree
- Created: 2022-07-06T08:32:42.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-25T15:22:17.000Z (over 3 years ago)
- Last Synced: 2025-01-19T13:16:14.203Z (over 1 year ago)
- Language: TypeScript
- Size: 477 KB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Spree CLI
Spree CLI is a tool that makes it easy to bootstrap a new Spree project.
It provides an interactive process for configuring Spree backend (running in Dockerized, Hybrid or Native mode) and a selection of available frontends.
## Dependencies
Node 14+ is required to run the CLI. Depending on the chosen Spree setup, you will have to install different dependencies first:
### Spree (dockerized)
- docker >= 20.0
- docker-compose
### Spree (no docker)
- ruby = 3.2.0
- vips >= 8.6
- gpg
- psql
- redis
### Spree (hybrid)
- docker >= 20.0
- docker-compose
- ruby = 3.2.0
- vips >= 8.6
- redis (only needed for running rspec tests)
### Vue Storefront
- node >= 14.15 <= 14.19
- yarn
### Next.js Commerce
- node >= 13.0
- yarn
## Usage
To get started, simply run the following command in your terminal:
```bash
npx @spree/cli new app
```
This will launch the interactive process that will guide you through the process of setting up a new Spree-based store.
In order to start the already generated app, navigate to your project's folder and run the following command:
```bash
npx @spree/cli start app
```
Happy hacking!
## Troubleshooting
### 1. NextJS storefront doesn't start properly
If the Storefront doesn't start you need to relaunch server manually.
To do so you should navigate to `/integration` folder inside created project and type `yarn dev` into console.
### 2. NextJS storefront stops during launch
In case if the server is randomly stopping during launch it is advised to stop it (for example with `ctrl + c`) and repeat steps mentioned above.
If you have encountered any other problem with NextJS you can also refer to NextJs docs: https://github.com/vercel/commerce
## Overview
This repository contains CLI to integrate Spree and storefront of your choice
This repository is being developed and maintained by [Upside](https://upsidelab.io)
