{"id":18561343,"url":"https://github.com/apostrophecms/starter-kit-ecommerce","last_synced_at":"2025-04-10T03:30:45.955Z","repository":{"id":185637265,"uuid":"654261937","full_name":"apostrophecms/starter-kit-ecommerce","owner":"apostrophecms","description":"An eCommerce-flavored starter kit for Apostrophe 3","archived":false,"fork":false,"pushed_at":"2024-12-18T19:07:29.000Z","size":10773,"stargazers_count":2,"open_issues_count":2,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-03T05:30:04.257Z","etag":null,"topics":["a3-starter-kit"],"latest_commit_sha":null,"homepage":"https://apostrophecms.github.io/starter-kit-ecommerce/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apostrophecms.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-15T18:26:29.000Z","updated_at":"2024-12-18T19:07:35.000Z","dependencies_parsed_at":null,"dependency_job_id":"f841b25f-4238-4ed0-a93d-87ef7439569c","html_url":"https://github.com/apostrophecms/starter-kit-ecommerce","commit_stats":null,"previous_names":["apostrophecms/starter-kit-ecommerce"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apostrophecms%2Fstarter-kit-ecommerce","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apostrophecms%2Fstarter-kit-ecommerce/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apostrophecms%2Fstarter-kit-ecommerce/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apostrophecms%2Fstarter-kit-ecommerce/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apostrophecms","download_url":"https://codeload.github.com/apostrophecms/starter-kit-ecommerce/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248150691,"owners_count":21055968,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["a3-starter-kit"],"created_at":"2024-11-06T22:06:34.653Z","updated_at":"2025-04-10T03:30:40.650Z","avatar_url":"https://github.com/apostrophecms.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Test](https://github.com/apostrophecms/starter-kit-ecommerce/actions/workflows/test.yml/badge.svg)](https://github.com/apostrophecms/starter-kit-ecommerce/actions/workflows/test.yml) [![Docs](https://github.com/apostrophecms/starter-kit-ecommerce/actions/workflows/docs.yml/badge.svg)](https://github.com/apostrophecms/starter-kit-ecommerce/actions/workflows/docs.yml)\n\n# E-commerce Starter Kit for ApostropheCMS\nAn e-commerce Starter Kit for ApostropheCMS built with Tailwind CSS.\n\nYou can find the full documentation on how to use and extend this starter kit below:\n* [User Guide](https://apostrophecms.github.io/starter-kit-ecommerce/user/)\n* [Developer Guide](https://apostrophecms.github.io/starter-kit-ecommerce/developer/)\n\nIf you prefer, you can follow [these steps](https://github.com/apostrophecms/starter-kit-ecommerce/blob/main/docs/README.md) to host the docs in your local environment.\n\n## Demo\n\u003cvideo src=\"https://user-images.githubusercontent.com/1889830/257869016-8707f5d1-b6cd-4db8-a433-393641feb3a3.mp4\" controls=\"controls\" style=\"max-width: 730px;\"\u003e\n\u003c/video\u003e\n\n## Getting started\n\nThis Starter Kit, also known as a boilerplate project, serves as a template for initiating new projects and is intended for use in two main ways:\n\n1. **Using Our CLI Tool**: Run our [CLI tool](https://github.com/apostrophecms/cli) to clone this template locally, install its dependencies, and set up an initial admin user. You accomplish this using:\n   \n   `apos create \u003cmy-project-name\u003e --starter=ecommerce`\n  \n2. **Manual Setup**: Manually `git clone` this repository and install its dependencies using `npm install`. Add an initial admin user with `node app @apostrophecms/user:add admin admin`.\n\nFor those who need to create multiple projects with additional base modules, consider [forking this repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) into your organizational or personal GitHub account. Customize it to fit your needs. To use your customized template, run the following CLI command:\n\n  `apos create \u003cproject-name\u003e --starter=\u003crepo-name\u003e`\n\nHere, `\u003crepo-name\u003e` should be the URL of your forked repository, excluding the `https://github.com/` part.\n\n**Note: This template is NOT designed to be installed into an existing project.**\n\n## Running the project\n\nRun `npm run dev` to build the Apostrophe UI and start the site up. Remember, this is during alpha development, so we're all in \"dev mode.\" The `dev` script will watch for saves in client-side CSS and JavaScript and trigger a build and page refresh if they are detected. It will also restart the app when server-side code is saved.\n\n## Making it your own\n\nThis boilerplate is designed so you can install and start running it right away. If you are starting a project that will go into production one day, there are a few things you should be sure to check:\n\n- [ ] **Update the shortname.** You don't need to perform this step if you created your project using the CLI tool. The `shortname` option in `app.js` is used for the database name (unless another is given in the `@apostrophecms/db` module). You should change this to an appropriate project name before you start adding any users or content you would like to keep.\n- [ ] **Update the Express.js session secret.** The secret is set to `undefined` initially in the `modules/@apostrophecms/express/index.js` file. You should update this to a unique string.\n- [ ] **Decide if you want hot reloading on.** This boilerplate uses nodemon to restart the app when files are changed. In `modules/@apostrophecms/asset/index.js` there is an option enabled to refresh the browser on restart. If you like this, do nothing. If you don't, remove the option or set it to `false`. The option has no effect when the app is in production.\n\n## Thanks\n\n![Thanks to our partner Corlette](https://static.apostrophecms.com/apostrophecms/starter-kit-ecommerce/images/corllete-thanks.png)\n\n### About Apostrophe\nApostropheCMS is a powerful content management system designed for developers who want to build dynamic and robust websites and applications. The intuitive admin interface provides a user-friendly editing experience, empowering content editors to create and update content effortlessly. As a developer, you have complete control over the content structure, defining custom schemas and creating relationships between different content types.\n\nWith its developer-friendly architecture, ApostropheCMS provides the flexibility and extensibility you need to build a simple blog, an enterprise-level website, or a complex web application.\n\n\n## Apostrophe starter kits\nThis Starter Kit was originally crafted by Corllete in partnership with Apostrophe. To learn more about Corllete visit [corllete.com](https://corllete.com). As with any open source project, this too is a community collaboration. We welcome feedback, tickets, bug fixes, and improvements.\n\nWant to upgrade your Starter Kit to Apostrophe Pro? [Get started here](https://apostrophecms.com/pro).\n\nInterested in publishing an Apostrophe Starter Kit and becoming a featured Apostrophe Partner? [Submit a Starter Kit](https://apostrophecms.com/starter-kits).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapostrophecms%2Fstarter-kit-ecommerce","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapostrophecms%2Fstarter-kit-ecommerce","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapostrophecms%2Fstarter-kit-ecommerce/lists"}