diff --git a/README.md b/README.md index b2128877..5c1a7553 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,63 @@ # Storefront — deco.cx template -Welcome to your [deco.cx](https://deco.cx) site! +A modern, high-performance e-commerce storefront template built with [deco.cx](https://deco.cx), Fresh, and Deno. This template provides a complete foundation for building fast, SEO-friendly online stores with a rich set of pre-built components and integrations. -## Usage +## What is this? -1 - [Install deno](https://docs.deno.com/runtime/manual/getting_started/installation/) +This is a production-ready e-commerce storefront template that includes: +- **Pre-built UI Components**: Ready-to-use sections for product displays, shopping cart, wishlist, search, and more +- **E-commerce Integrations**: Built-in support for platforms like Shopify, analytics, and more +- **Modern Stack**: Built on Deno, Fresh (Preact), and Tailwind CSS for optimal performance +- **Visual Editor**: Configure and customize your store through deco.cx's visual admin interface +- **SEO Optimized**: Server-side rendering and optimized images out of the box +- **TypeScript**: Fully typed codebase for better developer experience -2 - Run the command +## Key Features + +- Product listing and detail pages +- Shopping cart and checkout flow +- Product search and filtering +- Wishlist functionality +- Newsletter subscription +- Image galleries and carousels +- Responsive header and footer +- Social media integration (Instagram, WhatsApp) +- Cookie consent management +- Campaign timers and promotional banners +- Multiple theme options + +## Getting Started + +### Prerequisites + +Before you begin, make sure you have: +- [Deno](https://docs.deno.com/runtime/manual/getting_started/installation/) installed on your machine +- A code editor (VSCode recommended with extensions below) + +### Quick Start + +1. Clone this repository or use it as a template + +2. Install dependencies and start the development server: ```sh deno task start ``` -This will install all dependencies and start your project. +This will install all dependencies and start the development server. -Access `http://localhost:8000` to see your site. +3. Open your browser and navigate to `http://localhost:8000` + +You should see your storefront running locally! The site will automatically reload when you make changes. + +### Customization + +To customize your store: +- **Visual Editor**: Access the deco.cx admin interface to configure sections, themes, and content +- **Code**: Edit files in the `sections/`, `components/`, and `apps/` directories +- **Styling**: Modify Tailwind CSS classes or add custom styles +- **Integrations**: Configure your e-commerce platform connection in the admin ## Recommended extensions (VSCode) @@ -41,29 +83,14 @@ deno task update - 👥 [Discord](https://deco.cx/discord) +## About deco.cx + +[deco.cx](https://deco.cx) is a platform for building performant, composable web experiences. It combines the power of edge computing, visual editing, and modern web frameworks to create blazing-fast websites. + ## Contributing -We are working on the instructions, for now feel free to contribute to this project. - -Take a look on this ones: -- [deco](https://github.com/deco-cx/deco/) -- [apps](https://github.com/deco-cx/apps/) - -. -. -. -. -. -. -. -. -. -. -. -. -. -. -. -. -. -. -. + +Contributions are welcome! This template is part of the deco.cx ecosystem. If you'd like to contribute: + +- **This template**: Feel free to open issues or pull requests for improvements +- **Core platform**: Check out [deco](https://github.com/deco-cx/deco/) +- **Integration apps**: Explore [apps](https://github.com/deco-cx/apps/)