Skip to content

Hum2a/BakesByOlayide

BranchesTags

Repository files navigation

🍰 Bakery E-commerce Platform

Version License Build Status Coverage Dependencies Contributors Last Commit PRs Welcome Code Style

Bakery Logo

A modern e-commerce platform for bakeries

Features • Getting Started • Documentation • Contributing

📋 Table of Contents

Click to expand

✨ Features

🛍️ User Features

Click to expand

Authentication

  • 🔐 Secure login and registration
    • Email/Password authentication
    • Social media login (Google, Facebook)
    • Two-factor authentication
    • Remember me functionality
  • 👥 Guest checkout
    • No account required
    • Easy conversion to registered user
  • 🔄 Password reset
    • Secure token-based reset
    • Email verification
  • 🎭 Role-based access
    • Customer
    • Admin
    • Developer

Shopping Experience

  • 🛒 Smart cart system
    • Real-time updates
    • Save for later
    • Multiple delivery options
  • 💳 Multiple payment methods
    • Credit/Debit cards
    • PayPal
    • Apple Pay
    • Google Pay
  • 📦 Order tracking
    • Real-time status updates
    • Delivery notifications
    • Order history
  • 📱 Mobile-first design
    • Responsive layout
    • Touch-friendly interface
    • PWA support

Product Management

  • 🔍 Advanced search
    • Filters and sorting
    • Category navigation
    • Search suggestions
  • 🏷️ Product categories
    • Hierarchical structure
    • Custom attributes
    • Bulk management
  • ⭐ Reviews and ratings
    • Photo reviews
    • Verified purchases
    • Helpful votes
  • 📸 High-quality images
    • Zoom functionality
    • Multiple angles
    • Gallery view

👨‍💼 Admin Features

Click to expand

Dashboard

  • 📊 Real-time analytics
    • Sales metrics
    • User engagement
    • Conversion rates
  • 📈 Sales reports
    • Custom date ranges
    • Export options
    • Trend analysis
  • 👥 User management
    • User roles
    • Activity logs
    • Ban/Suspend users
  • 📦 Inventory control
    • Stock alerts
    • Low stock warnings
    • Automatic reordering

Order Management

  • 📝 Order processing
    • Status updates
    • Batch processing
    • Priority handling
  • 📦 Pickup scheduling
    • Calendar integration
    • Time slot management
    • Capacity planning
  • 📧 Automated notifications
    • Order confirmations
    • Shipping updates
    • Delivery notifications
  • 📊 Performance metrics
    • Processing times
    • Customer satisfaction
    • Error rates

🚀 Getting Started

Prerequisites

Software Version Description Download
Node.js >=14.0.0 JavaScript runtime Download
npm >=6.0.0 Package manager Download
Git >=2.0.0 Version control Download

Quick Start

# Clone the repository
git clone https://github.com/Hum2a/bakery.git
cd bakery

# Install dependencies
npm install

# Start development server
npm start

Development Workflow

graph TD
    A[Clone Repository] --> B[Install Dependencies]
    B --> C[Start Development Server]
    C --> D[Make Changes]
    D --> E[Run Tests]
    E --> F[Create Pull Request]
Loading

🛠️ Tech Stack

Frontend

Technology Purpose Version Documentation
React UI Framework 18.x Docs
Redux State Management 4.x Docs
Styled Components Styling 5.x Docs
React Router Navigation 6.x Docs

Backend

Service Purpose Version Documentation
Firebase Backend Services 9.x Docs
Firestore Database 9.x Docs
Firebase Auth Authentication 9.x Docs
Firebase Storage File Storage 9.x Docs

DevOps

Tool Purpose Version Documentation
GitHub Actions CI/CD Latest Docs
ESLint Code Linting 8.x Docs
Prettier Code Formatting 2.x Docs
Jest Testing 27.x Docs

📦 Installation

Development Setup

# Install dependencies
npm install

# Create environment file
cp .env.example .env

# Start backend and frontend (from root)
node server.js
# or for concurrent dev (if using scripts)
npm run dev

Production Setup

# Build for production
npm run build

# Start production server
npm run start:prod

Docker Setup

# Build Docker image
docker build -t bakery .

# Run container
docker run -p 3000:3000 bakery

🔧 Configuration

Environment Variables

# Firebase Configuration
REACT_APP_FIREBASE_API_KEY=your_api_key
REACT_APP_FIREBASE_AUTH_DOMAIN=your_auth_domain
REACT_APP_FIREBASE_PROJECT_ID=your_project_id
REACT_APP_FIREBASE_STORAGE_BUCKET=your_storage_bucket
REACT_APP_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_id
REACT_APP_FIREBASE_APP_ID=your_app_id

# Stripe Configuration
REACT_APP_STRIPE_PUBLIC_KEY=your_stripe_public_key

# Other Configuration
REACT_APP_API_URL=your_api_url
REACT_APP_ENV=development

📁 Project Structure

src/
├── components/          # Reusable UI components
│   ├── auth/           # Authentication components
│   ├── cart/           # Shopping cart components
│   ├── checkout/       # Checkout process components
│   ├── products/       # Product-related components
│   └── admin/          # Admin dashboard components
├── pages/              # Page components
├── hooks/              # Custom React hooks
├── context/            # React context providers
├── services/           # API and service functions
├── utils/              # Utility functions
├── styles/             # Global styles and themes
└── assets/             # Static assets

🗄️ Backend Structure & Usage

Folder Structure

backend/
  server.js           # Entry point for backend (imported by root server.js)
  app.js              # Main Express app setup
  config/
    firebase.js       # Firebase Admin SDK initialization (with local/prod fallback)
    nodemailer.js     # Nodemailer transporters
  routes/
    email.js          # All email-related routes
    ...               # Other route files as needed
  controllers/
    emailController.js
    ...               # Other controllers as needed

Running the Backend

  • Always start the backend from the project root:

    node server.js

    This ensures .env is loaded from the root and all paths work correctly.

  • The root server.js loads environment variables and then starts backend/server.js.

  • All backend code and configuration lives in the backend/ directory.

Environment Variables & Service Account

  • Place your .env file in the project root (never in backend/).
  • For Firebase Admin SDK:
    • In production (e.g., Render), set GOOGLE_APPLICATION_CREDENTIALS to the absolute path of your service account JSON.
    • In local development, leave GOOGLE_APPLICATION_CREDENTIALS unset and place your service account JSON in the repo (ignored by git). The backend will automatically use the local file if the env variable is not set or the file does not exist.
  • Example fallback logic (see backend/config/firebase.js): 
    const fs = require('fs');
const path = require('path');
let serviceAccount;
const envPath = process.env.GOOGLE_APPLICATION_CREDENTIALS;
if (envPath && fs.existsSync(envPath)) {
  serviceAccount = require(envPath);
} else {
  serviceAccount = require('../bakesbyolayide-firebase-adminsdk-*.json');
}

Development Setup (Updated)

# Install dependencies
npm install

# Create environment file
cp .env.example .env

# Start backend and frontend (from root)
node server.js
# or for concurrent dev (if using scripts)
npm run dev

🧪 Testing

Running Tests

# Run all tests
npm test

# Run tests with coverage
npm run test:coverage

# Run specific test file
npm test -- path/to/test.js

Test Coverage

File % Stmts % Branch % Funcs % Lines
All files 90 85 92 90
components/ 92 88 94 92
services/ 88 82 90 88

📚 Documentation

🤝 Contributing

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

Pull Request Process

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

🔒 Security

For security concerns, please see our Security Policy.

Security Features

  • 🔐 SSL/TLS encryption
  • 🔑 Secure password hashing
  • 🛡️ XSS protection
  • 🚫 CSRF protection
  • 🔍 Input validation
  • 📝 Audit logging

📄 License

This project is licensed under the MIT License - see the LICENSE.md file for details.

👥 Authors

Humza Butt
Humza Butt
💻 📖 ⚠️

📊 Performance

Lighthouse Scores

Category Score
Performance 95
Accessibility 100
Best Practices 100
SEO 100

Bundle Size

File Size Gzipped
main.js 1.2MB 350KB
vendor.js 2.1MB 650KB
styles.css 150KB 45KB

🔍 API Reference

Authentication

// Login
POST /api/auth/login
{
  "email": "user@example.com",
  "password": "password123"
}

// Register
POST /api/auth/register
{
  "email": "user@example.com",
  "password": "password123",
  "name": "John Doe"
}

Products

// Get all products
GET /api/products

// Get single product
GET /api/products/:id

// Create product
POST /api/products
{
  "name": "Chocolate Cake",
  "price": 29.99,
  "description": "Delicious chocolate cake"
}

🌐 Internationalization

The platform supports multiple languages:

  • 🇬🇧 English
  • 🇪🇸 Spanish
  • 🇫🇷 French
  • 🇩🇪 German
  • 🇮🇹 Italian

📱 Mobile Support

  • 📱 Responsive design
  • 📲 PWA support
  • 📱 Native-like experience
  • 📱 Offline functionality

🔧 Troubleshooting

Common Issues

Click to expand

Installation Issues

# Clear npm cache
npm cache clean --force

# Delete node_modules
rm -rf node_modules

# Reinstall dependencies
npm install

Build Issues

# Clear build cache
npm run clean

# Rebuild
npm run build

Development Issues

# Reset development environment
npm run reset

# Start fresh
npm start

📈 Roadmap

Version 2.0

  • Advanced analytics
  • AI-powered recommendations
  • Voice search
  • AR product preview

Version 2.1

  • Multi-vendor support
  • Subscription system
  • Advanced reporting
  • Mobile app
Built with ❤️ by the Bakery Team
Made with React and Firebase

About

E-commerce Platform for Bakery Business

bakesbyolayide.co.uk

Topics

react nodejs javascript css html firebase render firestore exoress

Resources

Readme

License

MIT license

Code of conduct

Code of conduct

Contributing

Contributing

Security policy

Security policy
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

3 tags

Sponsor this project

Packages

No packages published

Languages