Template

Use this structure when submitting your starter. Copy and replace the placeholders with your content. See Astro Medusa Starter as a reference example.


---
title: [Your Starter Name]
sidebarTitle: [Your Starter Name]
asIndexPage: true
---
 
# [Your Starter Name]
 
[One-sentence description of your starter and what it does.]
 
| Field | Details |
|-------|---------|
| **Status** | In Review |
| **Repository** | [github.com/owner/repo](https://github.com/owner/repo) |
| **Version** | <StarterVersion repo="owner/repo" fallback="1.0.0" /> |
| **Author** | [Author name] |
 
## Tech stack
 
| Layer | Technology |
|-------|------------|
| [Layer] | [Technology] |
| [Layer] | [Technology] |
 
## Features
 
- **[Feature name]** — [description]
- **[Feature name]** — [description]
 
## Compatibility
 
- **Medusa Version**: `v1` or `v2`
- **Node Version**: `>= 18`
- [Other requirements]
 
## Installation
 
### 1. Clone the repository
 
```bash
git clone https://github.com/owner/repo.git
cd repo/
yarn
```
 
### 2. Configure environment
 
[Environment setup steps]
 
### Prerequisites
 
- [Prerequisite 1]
- [Prerequisite 2]
 
### 3. Run development server
 
```bash
yarn dev
```
 
### 4. Build for production
 
```bash
yarn build
yarn preview
```
 
## Routes
 
[Optional — for storefronts. Table of routes and descriptions.]
 
## Project structure
 
[Optional — overview of project folders and their purpose.]
 
## License
 
[License name, e.g. MIT]
 
## Links
 
- [GitHub Repository](https://github.com/owner/repo)
- [Author contact — LinkedIn, GitHub, etc.]

Notes:

Replace owner/repo in StarterVersion with your repository (e.g. Bystrol/astro-medusa-starter)
Sections Routes and Project Structure are optional — include if relevant
Add or remove rows in Tech Stack and Features as needed
Ensure your repo has an official GitHub release for the version to display correctly