130 lines
4.8 KiB
Markdown
130 lines
4.8 KiB
Markdown
|
||
|
||
<div align="center">
|
||
<h1>Mercur <br> Open Source Marketplace Platform</h1>
|
||
<!-- Shields.io Badges -->
|
||
<a href="https://github.com/mercurjs/mercur/tree/main?tab=MIT-1-ov-file">
|
||
<img alt="License" src="https://img.shields.io/badge/license-MIT-blue.svg" />
|
||
</a>
|
||
<a href="#">
|
||
<img alt="PRs Welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" />
|
||
</a>
|
||
<a href="https://rigbyjs.com/#contact">
|
||
<img alt="Support" src="https://img.shields.io/badge/support-contact%20author-blueviolet.svg" />
|
||
</a>
|
||
<!-- Website Links -->
|
||
<p>
|
||
<a href="https://mercurjs.com/">Mercur</a> | <a href="https://docs.mercurjs.com/">Docs</a>
|
||
</p>
|
||
</div>
|
||
|
||
# What is Mercur?
|
||
|
||
<a href="https://www.mercurjs.com/">Mercur</a> is the first truly limitless open source marketplace platform that combines the simplicity of SaaS with the freedom of open source. Built on [MedusaJS](https://github.com/medusajs/medusa), it empowers businesses to create custom marketplaces without choosing between ownership and ease of use.
|
||
|
||
Mercur is a platform to start, customize, manage, and scale your marketplace for every business model with a modern technology stack.
|
||
|
||
## Announcing Mercur 1.0
|
||
|
||
After months of development, testing, and close collaboration with early adopters, we’re excited to announce the official release of **Mercur 1.0** - the first truly limitless marketplace platform. Version 1.0 is fully open source and ready to be self-hosted, giving you **full control over infrastructure, customizations, and data**.
|
||
|
||
With this version, **Mercur is production-ready for B2C marketplaces**. The first complete version includes a vendor system, admin panel, and a fully built B2C Storefront. Read more in **[official release announcement](https://www.mercurjs.com/updates/mercur-1-0-release)**
|
||
|
||
## Why Choose Mercur?
|
||
|
||
- Full Ownership: Unlike SaaS platforms, you own your marketplace with no transaction fees or vendor lock-in
|
||
- Modern Foundation: Built on MedusaJS, offering a modern tech stack that developers love
|
||
- Beautiful by Default: Create stunning storefronts without sacrificing customization
|
||
|
||
## Power Any Marketplace Model
|
||
|
||
- Custom B2B Marketplace: Build enterprise-grade platforms with specialized workflows
|
||
- Custom B2C Marketplace: Create engaging consumer marketplaces with modern UX
|
||
- eCommerce Extension: Transform your store into a marketplace (coming soon)
|
||
|
||
|
||
|
||
|
||
# Ready-to-go marketplace features
|
||
|
||
<b>Storefronts for Marketplace </b> <br>
|
||
Customizable storefronts designed for B2B and B2C with all elements including browsing and buying products across multiple vendors at once.
|
||
|
||
Discover <a href="https://github.com/mercurjs/b2c-marketplace-storefront">B2C Storefront Repository</a> - <a href="https://b2c.mercurjs.com/">🛍️ Check demo </a>
|
||
|
||
<b>Admin Panel</b> <br>
|
||
Control over whole marketplace: setting product categories, vendors, commissions and rules
|
||
|
||
<b>Vendor Panel</b> <br>
|
||
A powerful dashboard giving sellers complete control over their products, orders, and store management in one intuitive interface.
|
||
|
||
Discover <a href="https://github.com/mercurjs/vendor-panel">Vendor Panel</a> - <a href="https://www.mercurjs.com/contact"> Contact us to get demo </a>
|
||
|
||
<b>Integrations</b> <br>
|
||
Built-in integration with Stripe for payments and Resend for communication needs. More integrations coming soon.
|
||
|
||
|
||
|
||
|
||
|
||
## Quickstart
|
||
|
||
#### Setup Medusa project
|
||
|
||
```bash
|
||
# Clone the repository
|
||
git clone https://github.com/mercurjs/mercur.git
|
||
|
||
# Change directory
|
||
cd mercur
|
||
|
||
# Install dependencies
|
||
yarn install
|
||
|
||
# Build packages
|
||
yarn build
|
||
|
||
# Go to backend folder
|
||
cd apps/backend
|
||
|
||
# Clone .env.template
|
||
cp .env.template .env
|
||
|
||
# In the .env file replace user, password, address and port parameters in the DATABASE_URL variable with your values
|
||
DATABASE_URL=postgres://[user]:[password]@[address]:[port]/$DB_NAME
|
||
# For example:
|
||
DATABASE_URL=postgres://postgres:postgres@localhost:5432/$DB_NAME
|
||
|
||
# Setup database and run migrations
|
||
yarn medusa db:create && yarn medusa db:migrate && yarn run seed
|
||
|
||
# Create admin user
|
||
npx medusa user --email <email> --password <password>
|
||
|
||
# Go to root folder
|
||
cd ../..
|
||
|
||
# Start Mercur
|
||
yarn dev
|
||
```
|
||
|
||
|
||
|
||
## Prerequisites
|
||
|
||
- Node.js v20+
|
||
- PostgreSQL
|
||
- Git CLI
|
||
|
||
# Resources
|
||
|
||
#### Learn more about Mercur
|
||
|
||
- [Mercur Website](https://www.mercurjs.com/)
|
||
- [Mercur Docs](https://docs.mercurjs.com/introduction)
|
||
|
||
#### Learn more about Medusa
|
||
|
||
- [Medusa Website](https://www.medusajs.com/)
|
||
- [Medusa Docs](https://docs.medusajs.com/v2)
|