{"id":30020708,"url":"https://github.com/alanalvarez21/ecommerce-boilerplate","last_synced_at":"2026-05-20T05:36:37.467Z","repository":{"id":258376328,"uuid":"859086918","full_name":"AlanAlvarez21/ecommerce-boilerplate","owner":"AlanAlvarez21","description":"Ruby on Rails Ecommerce template","archived":false,"fork":false,"pushed_at":"2025-07-25T21:16:44.000Z","size":582,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-26T02:02:55.876Z","etag":null,"topics":["ruby","ruby-app","ruby-application","ruby-apps","ruby-gem","ruby-gems","ruby-lib","ruby-on-rails","rubygem","rubyonrails"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AlanAlvarez21.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2024-09-18T04:05:53.000Z","updated_at":"2025-07-25T21:15:03.000Z","dependencies_parsed_at":"2024-10-18T18:08:51.702Z","dependency_job_id":"029c2e57-1eee-4a72-8e5a-2e2081111571","html_url":"https://github.com/AlanAlvarez21/ecommerce-boilerplate","commit_stats":null,"previous_names":["alanalvarez21/coinsapp","alanalvarez21/ecommerce-boilerplate"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/AlanAlvarez21/ecommerce-boilerplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlanAlvarez21%2Fecommerce-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlanAlvarez21%2Fecommerce-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlanAlvarez21%2Fecommerce-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlanAlvarez21%2Fecommerce-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlanAlvarez21","download_url":"https://codeload.github.com/AlanAlvarez21/ecommerce-boilerplate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlanAlvarez21%2Fecommerce-boilerplate/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269005891,"owners_count":24343408,"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","status":"online","status_checked_at":"2025-08-06T02:00:09.910Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["ruby","ruby-app","ruby-application","ruby-apps","ruby-gem","ruby-gems","ruby-lib","ruby-on-rails","rubygem","rubyonrails"],"created_at":"2025-08-06T02:03:13.174Z","updated_at":"2025-11-11T18:22:50.348Z","avatar_url":"https://github.com/AlanAlvarez21.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🛒 E-commerce Boilerplate - Rails Template\n\n\u003e **A complete e-commerce template built with Rails 8 to launch your online store in minutes**\n\n[![Rails](https://img.shields.io/badge/Rails-8.0.1-red.svg)](https://rubyonrails.org/)\n[![Ruby](https://img.shields.io/badge/Ruby-3.3.4-red.svg)](https://www.ruby-lang.org/)\n[![Docker](https://img.shields.io/badge/Docker-Ready-blue.svg)](https://www.docker.com/)\n[![CI](https://github.com/AlanAlvarez21/ecommerce-boilerplate/actions/workflows/ci.yml/badge.svg)](https://github.com/AlanAlvarez21/ecommerce-boilerplate/actions)\n\n## 🎯 What is this project?\n\nThis is a complete e-commerce **boilerplate/template** designed to help you **launch your online store quickly**. It includes all the essential features you need to start selling products online, from inventory management to payment processing.\n\n### ⚡ **Why use this boilerplate?**\n\n- 🚀 **5-minute setup** - Uses Docker and devcontainers for development without complex configurations\n- 💳 **Ready payments** - Complete integration with MercadoPago\n- 📱 **Responsive** - Modern design with Tailwind CSS\n- 🔐 **Admin panel** - Complete administration panel\n- 📊 **Analytics** - Dashboard with sales metrics and reports\n- 🌐 **Multi-language** - Support for Spanish and English\n- ✅ **Tested** - Complete test suite with RSpec\n\n---\n\n## 🛍️ Main Features\n\n### **For Customers (Frontend)**\n- 🏪 **Product catalog** with categories and filters\n- 🛒 **Shopping cart** with session management\n- 💳 **Integrated checkout** with MercadoPago\n- 📱 **Responsive design** optimized for mobile\n- 🔍 **Intuitive search and navigation**\n\n### **For Administrators (Backend)**\n- 📊 **Dashboard with metrics** for sales and analytics\n- 📦 **Product management** (full CRUD)\n- 📂 **Category management** with images\n- 📋 **Order management** and status tracking\n- 📈 **Inventory control** and stock management\n- 👥 **Admin user system** with Devise\n\n### **Technical**\n- 🚀 **Rails 8.0.1** with latest improvements\n- 🐘 **PostgreSQL** as database\n- ⚡ **Stimulus + Turbo** for interactivity\n- 🎨 **Tailwind CSS** for styling\n- 🐳 **Docker** with devcontainers\n- 🧪 **RSpec** for testing\n- 🔒 **Brakeman** for security\n- 📈 **GitHub Actions** CI/CD\n\n---\n\n## 🚀 Quick Start\n\n### **1. Prerequisites**\n```bash\n# Install Docker\nhttps://www.docker.com/\n\n# Install Devcontainers CLI\nnpm install -g @devcontainers/cli\n# or with npx\nnpx install -g @devcontainers/cli\n```\n\n### **2. Clone and run**\n```bash\n# Clone the repository\ngit clone https://github.com/AlanAlvarez21/ecommerce-boilerplate.git\ncd ecommerce-boilerplate\n\n# Build the container (includes DB setup)\nbin/build_container\n\n# Seed the database with sample data\nbin/rails db:seed\n\n# Start the application\nbin/dev\n```\n\n### **3. Ready! 🎉**\n- **Frontend**: http://localhost:3000\n- **Admin Panel**: http://localhost:3000/admin\n- **Admin Credentials**: \n  - Email: `admin@coinsapp.com`\n  - Password: `password123`\n\n---\n\n## 📁 Project Structure\n\n```\n├── app/\n│   ├── controllers/\n│   │   ├── admin/          # Administration panel\n│   │   ├── application_controller.rb\n│   │   ├── cart_controller.rb\n│   │   ├── checkout_controller.rb\n│   │   └── ...\n│   ├── models/\n│   │   ├── admin.rb        # Admin users (Devise)\n│   │   ├── category.rb     # Product categories\n│   │   ├── product.rb      # Products\n│   │   ├── order.rb        # Purchase orders\n│   │   ├── stock.rb        # Inventory control\n│   │   └── ...\n│   ├── views/\n│   │   ├── admin/          # Admin panel views\n│   │   ├── layouts/        # Layouts (app and admin)\n│   │   └── ...\n│   └── services/\n│       └── mercado_pago_sdk.rb  # Payment integration\n├── config/\n│   ├── routes.rb           # Application routes\n│   └── ...\n├── db/\n│   ├── migrate/            # Migrations\n│   └── seeds.rb            # Sample data\n└── spec/                   # Tests with RSpec\n```\n\n---\n\n## 💳 Payment Setup (MercadoPago)\n\n### **1. Get credentials**\n1. Create account at [MercadoPago Developers](https://www.mercadopago.com/developers)\n2. Get your `ACCESS_TOKEN` and `PUBLIC_KEY`\n\n### **2. Configure environment variables**\n```bash\n# In .env or in your system\nexport MERCADOPAGO_ACCESS_TOKEN=\"your_access_token\"\nexport MERCADOPAGO_PUBLIC_KEY=\"your_public_key\"\n```\n\n### **3. Configure webhook**\n```bash\n# Webhook URL for notifications\nhttps://your-domain.com/webhooks/mercadopago\n```\n\n---\n\n## 🛠️ Development Commands\n\n```bash\n# Development\nbin/dev                     # Server + Tailwind watcher\nbin/rails server            # Rails server only\nbin/rails tailwindcss:watch # Tailwind watcher only\n\n# Database\nbin/rails db:create         # Create database\nbin/rails db:migrate        # Run migrations\nbin/rails db:seed           # Seed with sample data\nbin/rails db:reset          # Reset and seed\n\n# Testing\nbundle exec rspec           # Run tests\nbin/brakeman               # Security analysis\nbin/rubocop                # Code linting\n\n# Assets\nbin/rails assets:precompile # Compile assets for production\nbin/rails tailwindcss:build # Build Tailwind CSS\n```\n\n---\n\n## 🎨 Customization\n\n### **1. Change visual theme**\n```scss\n// In app/assets/stylesheets/application.tailwind.css\n// Customize main colors\n:root {\n  --primary-color: #3b82f6;\n  --secondary-color: #64748b;\n}\n```\n\n### **2. Modify default products**\n```ruby\n# In db/seeds.rb\n# Change categories and products according to your business\ncategories = Category.create!([\n  {\n    name: \"Your Category\",\n    description: \"Your category description\",\n    # ...\n  }\n])\n```\n\n### **3. Customize texts**\n```yaml\n# In config/locales/en.yml\nen:\n  app_name: \"Your Store\"\n  meta_title: \" - The best online store\"\n  # ...\n```\n\n---\n\n## 📊 Administration Panel\n\nThe admin panel includes:\n\n- **📈 Dashboard**: Sales metrics, recent orders, best-selling products\n- **🛍️ Products**: Full CRUD with image management\n- **📂 Categories**: Organization with catalog images\n- **📋 Orders**: Status management and tracking\n- **📦 Inventory**: Stock control per product\n- **👥 Admins**: Administrator user management\n\n### **Access**\n- URL: `/admin`\n- Authentication: Devise\n- Permissions: Admin users only\n\n---\n\n## 🧪 Testing\n\nComplete test suite:\n\n```bash\n# Unit tests\nbundle exec rspec spec/models/\n\n# Controller tests\nbundle exec rspec spec/controllers/\n\n# Request tests\nbundle exec rspec spec/requests/\n\n# System tests (E2E)\nbundle exec rspec spec/system/\n\n# Coverage report\nopen coverage/index.html\n```\n\n---\n\n## 🚀 Deployment\n\n### **Heroku**\n```bash\n# Create application\nheroku create your-store\n\n# Configure variables\nheroku config:set RAILS_MASTER_KEY=your_master_key\nheroku config:set MERCADOPAGO_ACCESS_TOKEN=your_token\n\n# Deploy\ngit push heroku main\n\n# Initial setup\nheroku run rails db:migrate\nheroku run rails db:seed\n```\n\n🎯 Seeds summary:\n  📂 Categories: 6\n  🪙 Products: 15\n  📦 Stock entries: 15\n  👤 Admins: 1\n  📋 Orders: 5\n  🛒 Order products: 11\n\n🔐 Admin credentials:\n  Email: admin@coinsapp.com\n  Password: password123\n  \n\n### **Docker Production**\n```bash\n# Build image\ndocker build -t your-store .\n\n# Run\ndocker run -p 3000:3000 \\\n  -e RAILS_ENV=production \\\n  -e DATABASE_URL=postgres://... \\\n  your-store\n```\n\n---\n\n## 🤝 Contributing\n\n1. **Fork** the repository\n2. **Create** a feature branch (`git checkout -b feature/AmazingFeature`)\n3. **Commit** your changes (`git commit -m 'Add some AmazingFeature'`)\n4. **Push** to the branch (`git push origin feature/AmazingFeature`)\n5. **Create** a Pull Request\n\n---\n\n## 📝 Ideal Use Cases\n\nThis boilerplate is perfect for:\n\n- 🏪 **Small/medium stores** that need quick online presence\n- 💎 **Specialized products** (jewelry, collectibles, crafts)\n- 🎨 **Artists and makers** who want to sell their creations\n- 📚 **Educational or niche stores**\n- 🚀 **E-commerce MVPs** to validate business ideas\n- 👨‍💻 **Developers** who need a solid starting point\n\n---\n\n## 📋 Roadmap\n\n### **Upcoming features:**\n- [ ] 🔍 Advanced search with filters\n- [ ] ⭐ Review and rating system\n- [ ] 📧 Integrated email marketing\n- [ ] 📱 PWA (Progressive Web App)\n- [ ] 🌍 More payment gateways\n- [ ] 📦 Shipping system integration\n- [ ] 🤖 Basic chatbot\n- [ ] 📊 Advanced analytics\n\n---\n\n## 📄 License\n\nThis project is under the MIT license. See `LICENSE` for more details.\n\n---\n\n## 🆘 Support\n\n- 📖 **Documentation**: [Project Wiki](https://github.com/AlanAlvarez21/ecommerce-boilerplate/wiki)\n- 🐛 **Issues**: [Report problems](https://github.com/AlanAlvarez21/ecommerce-boilerplate/issues)\n- 💬 **Discussions**: [GitHub Discussions](https://github.com/AlanAlvarez21/ecommerce-boilerplate/discussions)\n\n---\n\n**🚀 Launch your e-commerce today!** This boilerplate saves you weeks of initial development.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falanalvarez21%2Fecommerce-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falanalvarez21%2Fecommerce-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falanalvarez21%2Fecommerce-boilerplate/lists"}