Skip to main content

Welcome to BeanQuick

Connect local businesses with customers through a powerful marketplace platform for online ordering and delivery management

Quick Start

Get up and running with BeanQuick in minutes

1

Set up your environment

Clone the repository and install dependencies for both backend and frontend.
git clone https://github.com/SeboskiHub/bean-quick.git
cd bean-quick
2

Configure the backend

Set up your Laravel backend with database and environment variables.
cd back-end
composer install
cp .env.example .env
php artisan key:generate
php artisan migrate
3

Launch the application

Start both the API server and the React frontend.
# In back-end directory
php artisan serve

# In a new terminal, from front-end directory
cd front-end
npm install
npm run dev

Explore by Role

Find the documentation that matches your use case

Customer Guide

Browse businesses, manage your cart, place orders, and leave reviews

Business Guide

Manage your products, track orders, and grow your business

Admin Guide

Approve businesses, manage users, and oversee platform operations

Key Features

Everything you need to run a successful marketplace

Business Registration

Multi-step registration with admin approval workflow

Product Management

Full CRUD operations for managing business inventory

Shopping Cart

Session-based cart with real-time updates

Order Management

Track orders from placement to delivery

Payment Integration

Secure payments powered by Mercado Pago

Ratings & Reviews

Build trust with customer feedback

API Reference

Explore the complete API documentation

Authentication

User login, registration, and session management

Customer API

Shopping cart, orders, and reviews endpoints

Business API

Product management, orders, and analytics

Admin API

Business approvals, user management, and platform admin

Ready to get started?

Follow our quickstart guide to set up BeanQuick and start building your marketplace

Get Started Now

Build docs developers (and LLMs) love