robo-store v0.0.3

!NOTE

Welcome to robo-store, a minimalist yet powerful eCommerce plugin for Robo.js! This plugin integrates a dynamic storefront, Discord slash commands, and an API-powered backend to provide a comprehensive shopping experience. Perfect for exclusive communities, robo-store lets you create a member-only shopping platform with seamless Discord integration, beautiful Astro-powered storefronts, and easy management through customizable options.

🌟 Features

robo-store brings a minimal eCommerce solution right into your Discord server and online presence:

• Discord Slash Commands – Manage your store directly from Discord with commands for adding products, listing items, placing orders, and more.
• Backend Server API – A fully functional API for handling store data, from product information to customer orders.
• Agnostic Storefront Support – A fast, customizable, and responsive web interface that can be integrated with any frontend framework or technology, making it perfect for showcasing products flexibly.
• Customizable Options – Set your store name, branding, introduction, and more with a flexible configuration system.
• Seamless Discord Integration – Supports Discord login for easy customer access, with seamless order management.

🛠 Installation

You can add robo-store with one command via Robo CLI:

terminal

# Using Robo CLI
npx robo add robo-store
# Or if using pnpm, yarn, or bun:
pnpm robo add robo-store
yarn robo add robo-store
bun robo add robo-store

📂 Configuration

To configure your robo-store plugin, configure your plugin config with the following options:

/config/plugins/robo-store.ts

export default {
	mongo_uri: 'your-mongodb-uri',
	owner_id: 'discord-user-id',
	store_name: 'Your Store Name',
	domain: 'https://yourstore.com',
	slogan: 'Your Store Slogan',
	hero_image: 'link-to-hero-image',
	about_us: 'Description of your store',
	invite: 'Discord invite link',
	introduction: 'Brief intro for new customers',
	client_secret: 'discord-client-secret',
	client_id: 'discord-client-id',
	currency_symbol: '$',
	imgbb_api_key: 'optional-imgbb-api-key-for-image-hosting',
	port: 6969
};

!TIP Most fields have default values if not provided, to streamline your setup!

📝 Plugin Options Reference

Check out the example configuration file for more details.

🚀 Quick Start

1. Install the Plugin: Quickly set up the plugin with just a few commands.
2. Customize Your Store: Use provided options like store_name, slogan, and about_us to make it yours.
3. Run Your Bot: Start the Discord bot, and let your customers explore your store through slash commands!
4. Manage Products & Orders: Use the backend API to add, update, and track products and orders.

🧩 Slash Commands

🚀 Backend API

This table lists all the main backend API routes, the HTTP method, their descriptions, required parameters, and the request type for each route.

🎥 Demo

robo-store-screenshots/robo-store.mp4

https://github.com/user-attachments/assets/2332de81-c31b-4415-b5fe-a887dd9c4f6f

📷 Screenshots

Here's a collection of screenshots showing various features and pages of the Robo Store.

Hero Section

Shop Products Page

Product Page

Out of Stock Product Page

Cart Preview

Store My Order Info

New Order Received Notification (admin pov)

User Account on Storefront

Store Admin Apply Discount

Store Admin New Product

Store Admin Order Status

Store Admin Stockout

Website

💻 Contributing

!TIP
We welcome contributions to improve robo-store! If you have suggestions, bug fixes, or new feature ideas, follow these steps:

1. Fork the Repository
   Click the Fork button at the top-right of the repo page.

2. Clone Your Fork
   Clone the repo locally:

   git clone https://github.com/ArnavK-09/robo-store.git

3. Create a Branch
   Create a new branch for your changes:

   git checkout -b your-feature-branch

4. Make Changes
   Implement your changes (bug fixes, features, etc.).

5. Commit and Push
   Commit your changes and push the branch:

   git commit -m "Description of changes"
   git push origin your-feature-branch

6. Open a Pull Request
   Open a PR with a detailed description of your changes.

7. Collaborate and Merge
   The maintainers will review your PR, request changes if needed, and merge it once approved.

🙋‍♂️ Issues

Found a bug or need help? Please create an issue on the GitHub repository with a detailed description.

👤 Author

🗺 Roadmap