https://github.com/barkprotocol/bark-ecommerce
Monorepo including medusajs 2.0 backend and storefront
https://github.com/barkprotocol/bark-ecommerce
Last synced: 11 months ago
JSON representation
Monorepo including medusajs 2.0 backend and storefront
- Host: GitHub
- URL: https://github.com/barkprotocol/bark-ecommerce
- Owner: barkprotocol
- License: mit
- Created: 2024-08-19T10:56:02.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-19T12:55:19.000Z (almost 2 years ago)
- Last Synced: 2024-12-29T10:44:19.672Z (over 1 year ago)
- Language: TypeScript
- Size: 940 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
BARK: A Headless eCommerce Platform
Documentation |
Website
BARK | Commerce is an innovative, headless eCommerce platform that leverages the power of MedusaJS, Solana blockchain, and USDC stablecoin. Designed for modern businesses, BARK offers a decentralized, scalable, and flexible solution for all your eCommerce needs. The platform integrates seamlessly with modern technologies to provide a robust, customizable, and future-proof solution for online retailers. With its decentralized structure and powerful integrations, BARK ensures your business stays ahead in the ever-evolving digital marketplace.
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Integration Details](#integration-details)
- [Solana Integration](#solana-integration)
- [USDC Integration](#usdc-integration)
- [References](#references)
- [Contributing](#contributing)
- [License](#license)
## Introduction
The BARK eCommerce platform is built on the robust MedusaJS framework, providing a seamless headless eCommerce experience that emphasizes speed, flexibility, and cutting-edge blockchain technology. By integrating Solana for lightning-fast transactions and USDC for stable payments, BARK offers a reliable and future-proof solution for online retailers.
## Features
- **Headless Architecture:** A decoupled front-end and back-end structure for maximum flexibility and customization, allowing seamless integration with various front-end frameworks.
- **Solana Blockchain Support:** Leverage Solana's high-speed and low-cost transaction capabilities for efficient payment processing, ensuring quick and secure transactions.
- **USDC Payment Gateway:** Utilize USDC stablecoin to minimize currency volatility and ensure stable transactions, offering a reliable payment method for customers.
- **Customizable and Scalable:** Adapt the platform to fit your specific business requirements and scale effortlessly as you grow, providing a tailored solution for various industries.
- **Decentralized Solutions:** Enhance security and transparency through the power of blockchain technology, providing peace of mind for you and your customers by ensuring data integrity and protection.
## Getting Started
To get your development environment ready and start using BARK, follow these steps.
### Prerequisites
- **Node.js:** v14.x or later
- **PostgreSQL:** A reliable database solution for storing application data
- **Yarn or npm:** Your preferred package manager
### Installation
1. **Clone the Repository:**
```bash
git clone https://github.com/barkprotocol/ecommerce-platform.git
cd ecommerce-platform
```
2. **Install Dependencies:**
```bash
yarn install
```
or
```bash
npm install
```
3. **Set Up the Database:**
Configure your PostgreSQL database and update the environment variables accordingly.
### Configuration
1. **Environment Variables:**
Create a `.env` file and configure it with your database and API keys:
```plaintext
DATABASE_URL=postgresql://username:password@host:port/database
SOLANA_API_KEY=your_solana_api_key
USDC_API_KEY=your_usdc_api_key # Circle API key
```
2. **Configure Medusa:**
Ensure MedusaJS is properly set up to handle headless operations by following the [MedusaJS setup guide](https://docs.medusajs.com/development/overview).
## Usage
Start the development server:
```bash
yarn start
```
or
```bash
npm start
```
This will launch the server, and you can access your eCommerce platform locally at `http://localhost:YOUR_PORT`.
## Integration Details
### Solana Integration
BARK utilizes the Solana blockchain to provide fast and cost-effective transactions. Make sure your Solana API key is correctly configured in your `.env` file. For more information, refer to the [Solana documentation](https://docs.solanalabs.com/).
### USDC Integration
The USDC payment gateway enables stablecoin transactions, reducing volatility risks. Ensure your API configuration is correct in the `.env` file. More details can be found in the [Circle documentation](https://circle.com/en/).
## References
- [MedusaJS Documentation](https://docs.medusajs.com/development/overview)
- [Circle Documentation](https://circle.com/en/)
- [Solana Documentation](https://docs.solanalabs.com/)
## Contributing
Contributions are welcome and appreciated. Please follow the steps below to contribute to BARK:
1. Fork the repository.
2. Create a new feature branch (`git checkout -b feature/YourFeature`).
3. Commit your changes (`git commit -m 'Add a cool feature'`).
4. Push to the branch (`git push origin feature/YourFeature`).
5. Open a pull request.
For more detailed guidelines, please refer to the `CONTRIBUTING.md` file.
## License
The MIT License. See the `LICENSE` file for details.