Skip to content

oreoluwa648/oreel

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Oreel - Cosmetics & Fashion E-Commerce on Stellar Blockchain

TypeScript Next.js React Native Express Stellar

🌟 Overview

Oreel is a revolutionary e-commerce platform for cosmetics and fashion products built on the Stellar blockchain. By leveraging blockchain technology, we provide transparent transactions, secure payments, and authentic product verification for the beauty and fashion industry.

✨ Key Features

  • Blockchain-Powered Payments: Secure and transparent transactions using Stellar network
  • Multi-Platform Support: Web (Next.js) and Mobile (React Native) applications
  • Real-Time Chat: Integrated customer support and vendor communication
  • Product Authentication: Verify product authenticity via blockchain
  • Smart Contracts: Automated escrow and dispute resolution
  • Digital Asset Management: Tokenized loyalty rewards and product ownership

🏗️ Project Structure

oreel/
├── oreel-web/                 # Next.js web application
├── oreel-mobile/              # React Native mobile app
├── oreel-backend/             # Express.js backend API
├── docs/                       # Documentation
├── contracts/                  # Stellar smart contracts
└── README.md                   # This file

🚀 Getting Started

Prerequisites

  • Node.js 18+
  • npm or yarn
  • PostgreSQL 14+
  • MongoDB 6+
  • Redis (for caching and real-time features)
  • Git
  • Stellar account (testnet for development)

Quick Start

  1. Clone the repository
    git clone https://github.com/yourusername/oreel.git
    cd oreel
  1. Install dependencies for all services
    # Install web dependencies
    cd oreel-web && npm install

    # Install mobile dependencies
    cd ../oreel-mobile && npm install

    # Install backend dependencies
    cd ../oreel-backend && npm install
  1. Set up environment variables Copy the example environment files and configure them for each service:
# Backend
cp oreel-backend/.env.example oreel-backend/.env

# Web
cp oreel-web/.env.example oreel-web/.env.local

# Mobile
cp oreel-mobile/.env.example oreel-mobile/.env
  1. Start databases
    # Using Docker (recommended)
    docker-compose up -d postgres mongodb redis

    # Or start services manually
  1. Run database migrations
    cd oreel-backend
    npm run prisma:migrate
    npm run seed
  1. Start development servers
    # Backend (from oreel-backend)
    npm run dev

    # Web (from oreel-web)
    npm run dev

    # Mobile (from oreel-mobile)
    npm start

💻 Development Guides

Web Application (Next.js)

  • URL: http://localhost:3000
  • Docs: Web README
  • Tech Stack: Next.js 14, Tailwind CSS, Zustand, React Query

Mobile Application (React Native)

  • Run on iOS: npm run ios
  • Run on Android: npm run android
  • Docs: Mobile README
  • Tech Stack: Expo, React Navigation, NativeWind

Backend API

  • URL: http://localhost:5000
  • API Docs: http://localhost:5000/api-docs
  • Docs: Backend README
  • Tech Stack: Express.js, Prisma, Mongoose, Socket.io

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Workflow

  1. Fork the repository
  2. Create a feature branch
    git checkout -b feature/amazing-feature
  1. Commit your changes
git commit -m 'feat: add amazing feature'
  1. Push to the branch
git push origin feature/amazing-feature
  1. Open a Pull Request

🙏 Acknowledgments

  • Stellar Development Foundation
  • Open source community
  • All our contributors and supporters

Built with ❤️ for the beauty, fashion and stellar communities

About

Oreel is a revolutionary e-commerce platform for cosmetics and fashion products built on the Stellar blockchain. By leveraging blockchain technology, we provide transparent transactions, secure payments, and authentic product verification for the beauty and fashion industry.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors