Skip to content

Latest commit

 

History

History
60 lines (35 loc) · 1.74 KB

README.md

File metadata and controls

60 lines (35 loc) · 1.74 KB
Raw

Honest Reviews

Honest Reviews is an example for developing Swell Apps.

Swell Apps is currently in closed alpha phase, available to select partners. Read more in the alpha documentation.

Getting Started

During alpha and beta phases, you'll install a local copy of the app in your own store using the CLI. This allows you to make changes to the code and help improve things for the community. Pull requests welcome.

  1. Clone this repository.
  2. Install the Swelll CLI.
npm install @swell/cli@alpha
  1. Log in and push the app to your test store.
cd /path/to/honest-reviews-app

swell login

swell app push

Storefront setup

Honest Reviews is bundled with a Next.js 14 app that shows how a frontend can integrate with models, fetch data and interact with app functions.

  1. In the Swell dashboard, navigate to Developer > API keys and create a public key with permissions for Honest Reviews. Enter your store ID and public key in /path/to/honest-reviews-app/storefront/.env.local.
NEXT_PUBLIC_SWELL_STORE_ID=...
NEXT_PUBLIC_SWELL_STORE_KEY=pk_test_...
  1. Install dependencies and run it locally.
cd storefront/

npm install

npm run dev

Important note

The app isn't ready for production use at this time, but should serve as an example with code patterns you can learn from.

Contributing

Contributions are welcome! Visit the Swell Discord or GitHub discussions to get help and share ideas.

License

This project is licensed under the MIT License - see LICENSE.md file for details.