B8 Platform

B8 Platform is a focused mentoring and community platform, centered around the BGr8 initiative and powered by a unique MentorAlgorithm.

📖 Table of Contents

• Overview
• Features
• Tech Stack
• Prerequisites
• Installation
• Deployment
• Environment Variables
• Testing
• Project Structure
• Contributing
• License
• Security
• Contact
• Acknowledgments

🎯 Overview

B8 Platform is dedicated to empowering individuals through the BGr8 community and a robust mentoring program. The platform now focuses exclusively on:

Unit	Description	Status
🌟 BGr8	Community, events, and mentoring	Live

🚀 Features

Click to expand feature list

Core Features

• 🌟 BGr8 community hub
• 🤝 Mentor matching and management (MentorAlgorithm)
• 🔒 Secure authentication
• 💳 Secure payment processing with Stripe
• 📱 Responsive design
• 📊 Analytics integration
• 💬 Enquiries and admin management

Technical Features

• 🔑 Firebase authentication
• 🔥 Firestore database
• 💸 Stripe payments
• ⚡ Real-time updates
• 🧑‍💻 Modern React + TypeScript stack

🛠️ Tech Stack

Our platform is built with modern technologies:

graph TD
    A[Frontend] --> B[React + TypeScript]
    A --> C[Vite]
    D[Backend Services] --> E[Firebase]
    E --> F[Authentication]
    E --> G[Firestore]
    E --> H[Storage]
    I[Analytics] --> J[Google Analytics]
    K[Payments] --> L[Stripe]
    L --> M[Stripe Checkout]
    L --> N[Stripe Webhooks]

Loading

📋 Prerequisites

Before you begin, ensure you have:

• Node.js (v16.x or higher)
• npm (v8.x or higher)
• Firebase account and project
• Stripe account with API keys
• Stripe CLI (for webhook testing)

🛠️ Installation

Step-by-step installation guide

1. Clone the repository:

   git clone https://github.com/Hum2a/B8.git
   cd B8

2. Install dependencies:

   npm install

3. Set up environment variables: You will need your own firebase account. Get the correct .env file from Hum2a to place in the root directory.

4. Set up Stripe server environment: Place the stripe .env file provided by Hum2a into the stripe directory, or create it as follows:

   STRIPE_SECRET_KEY=your_stripe_secret_key
   STRIPE_WEBHOOK_SECRET=your_stripe_webhook_secret
   PORT=3001
   CLIENT_URL=http://localhost:5173

5. Start the development servers:

   # Start the main application
   npm run dev
   
   # Start the Stripe server (in a separate terminal)
   cd stripe && node server.js

🚀 Deployment

Deployment instructions

Production Build

npm run build

Preview Production Build

npm run preview

📝 Environment Variables

Required environment variables:

View all environment variables

Variable	Description	Required
VITE_FIREBASE_API_KEY	Firebase API Key	✅
VITE_FIREBASE_AUTH_DOMAIN	Firebase Auth Domain	✅
VITE_FIREBASE_PROJECT_ID	Firebase Project ID	✅
VITE_FIREBASE_STORAGE_BUCKET	Firebase Storage Bucket	✅
VITE_FIREBASE_MESSAGING_SENDER_ID	Firebase Messaging Sender ID	✅
VITE_FIREBASE_APP_ID	Firebase App ID	✅
VITE_FIREBASE_MEASUREMENT_ID	Firebase Measurement ID	✅
VITE_STRIPE_PUBLISHABLE_KEY	Stripe Publishable Key	✅
VITE_STRIPE_SERVER_URL	Stripe Server URL	✅
STRIPE_SECRET_KEY	Stripe Secret Key (server)	✅
STRIPE_WEBHOOK_SECRET	Stripe Webhook Secret (server)	✅

🧪 Testing

# Run unit tests
npm run test

# Run end-to-end tests
npm run test:e2e

# Run tests in CI environment
npm run test:ci

📦 Project Structure

View project structure

B8/
├── src/
│   ├── components/         # React components
│   ├── pages/              # Page components
│   ├── hooks/              # Custom React hooks
│   ├── contexts/           # React context providers
│   ├── services/           # API and service integrations
│   ├── utils/              # Utility functions
│   ├── types/              # TypeScript type definitions
│   └── MentorAlgorithm/    # Mentor matching logic
├── stripe/                 # Stripe server
├── public/                 # Static assets
├── ...

🤝 Contributing

See CONTRIBUTING.md for guidelines.

📝 License

This project is licensed under the MIT License.

🔒 Security

See SECURITY.md for security policy and reporting.

📬 Contact

For questions, contact Humza (Hum2a) or open an issue.

🙏 Acknowledgments

Thanks to all contributors and the BGr8 community!