https://github.com/duncanmcclean/sc-starter-kit

Simple Commerce - Starter Kit
https://github.com/duncanmcclean/sc-starter-kit

hacktoberfest simple-commerce statamic-starter-kit statamic-v3

Last synced: 24 days ago
JSON representation

Simple Commerce - Starter Kit

• Host: GitHub
• URL: https://github.com/duncanmcclean/sc-starter-kit
• Owner: duncanmcclean
• Created: 2020-07-19T16:52:05.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-17T02:34:29.000Z (3 months ago)
• Last Synced: 2024-08-17T03:33:55.661Z (3 months ago)
• Topics: hacktoberfest, simple-commerce, statamic-starter-kit, statamic-v3
• Language: Antlers
• Homepage: https://statamic.com/sc-starter-kit
• Size: 10.8 MB
• Stars: 39
• Watchers: 2
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




    

    






## Simple Commerce Starter Kit

The Simple Commerce Starter Kit is a great starting point to build bespoke e-commerce sites. You can either build on top of this Starter Kit or simply use it as a reference point for working with Simple Commerce's [Antlers Tags](https://simple-commerce.duncanmcclean.com/tags) (**recommended**).

Before deploying to production, please remember to purchase a license from the [Statamic Marketplace](https://statamic.com/simple-commerce).

## Quick Start

You can quickly create a new site using the [Statamic CLI](https://github.com/statamic/cli).

```

statamic new artisan-bakery duncanmcclean/sc-starter-kit

```

**And that should be you setup! 🎉**

## Front-end stack

Tailwind CSS & Alpine.js are used out-of-the-box but feel free to change them out if you're more comfortable with something else. For building CSS & JS, this starter kit uses [Vite](https://laravel.com/docs/9.x/vite). It's configured to compile one CSS file and one JS file.

-   `resources/css/site.css` -> `public/css/site.css`

-   `resources/js/site.js` -> `public/js/site.js`

There's also a few commands you can run to compile your assets for various environments.

-   `npm run dev` - runs a local watcher

-   `npm run build` - to build your CSS & JavaScript, ready for production

## Inspired by Peak

Parts of the Simple Commerce Starter Kit have been inspired/borrowed from the popular [Peak starter kit](https://github.com/studio1902/statamic-peak). If you're not familiar with Peak, I'd highly recommend checking it out.

If you want to use all the features in Peak, you should install the Peak Starter Kit first, then [install Simple Commerce on top](https://simple-commerce.duncanmcclean.com/installation#content-installing-into-an-existing-site).

---

For more information on using Simple Commerce, please review the [Simple Commerce documentation](https://simple-commerce.duncanmcclean.com).