GoGrocery E-Commerce Website

GoGrocery is a PHP + MySQL e-commerce web application.
This repository includes everything needed to set up the project locally:

• Database schema (db.sql)
• User accounts (grocery_customer) **gogrocery_dev (optional, need to configure everything on your own as an alternative for root account))
• .env configuration
• Composer dependencies

---

🚀 Quick Start (Developers)

# 1. Clone repo
git clone  gogrocery
cd gogrocery

# 2. Install dependencies
composer install

# 3. Import schema, users, and seed data (run as root)
mysql -u root -p < database/db.sql
mysql -u root -p < database/users.sql
mysql -u root -p gogrocery < database/seed.sql

# 4. Create environment file
cp .env.example .env   # (Linux/macOS)
copy .env.example .env # (Windows)

# 5. Test DB connection
php connect_db.php

# 6. Run development server
php -S localhost:8000 -t public

Visit → http://localhost:8000

Login to phpMyAdmin with:

• Username: gogrocery_customer
• Password: StrongCustomerPassword123!

---

📋 Requirements

• PHP 8.1+ (WAMP, XAMPP, or MAMP includes PHP)
• MySQL 8+ (or MariaDB)
• Composer (https://getcomposer.org/)
• Git
• Web server (Apache/Nginx) or PHP built-in server

---

⚙️ 1. Clone Repository

git clone https://github.com/yourusername/gogrocery.git
cd gogrocery

---

📦 2. Install Composer

Windows

1. Download Composer installer → https://getcomposer.org/download/
2. Run the installer and select your PHP executable (from WAMP/XAMPP).
3. Verify installation:

composer -V

Linux/macOS

php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
php composer-setup.php
php -r "unlink('composer-setup.php');"
sudo mv composer.phar /usr/local/bin/composer
composer -V

---

🗄️ 3. Setup MySQL Database

Step 1: Create Database & Import Schema Run as root:

mysql -u root -p < database/db.sql

---

Step 2: Create Users Run as root:

mysql -u root -p < database/users.sql

This creates:

• gogrocery_customer → used by backend app & developers (limited privileges)
• gogrocery_dev (optional) → alternative admin account for schema changes

---

Step 3: Insert Sample Data Run as root:

mysql -u root -p gogrocery < database/seed.sql

---

🔑 4. Setup Environment File

Duplicate the example:

Linux/macOS

cp .env.example .env

Windows (PowerShell)

copy .env.example .env

Default .env:

# Database host and name
DB_HOST=localhost
DB_NAME=gogrocery

# Application / customer account (limited privileges)
DB_USER=gogrocery_customer
DB_PASS=StrongCustomerPassword123!

# Developer / admin account (optional: alternative for root)
DB_ADMIN_USER=gogrocery_dev
DB_ADMIN_PASS=StrongDevPassword123!

⚠️ If you change usernames/passwords in users.sql, update them here.

---

📥 5. Install PHP Dependencies

composer install

---

▶️ 6. Run the Application

Option 1: WAMP/XAMPP (Recommended)

• Place project inside C:\wamp64\www\ or C:\xampp\htdocs\
• Visit: http://localhost/gogrocery

Option 2: PHP Built-in Server

php -S localhost:8000 -t public

Then open: http://localhost:8000

Database Access (phpMyAdmin)

• Start phpMyAdmin from WAMP/XAMPP or visit: http://localhost/phpmyadmin
• Login with:
• Username: gogrocery_customer
• Password: StrongCustomerPassword123!

---

🧪 7. Test Database Connection

php connect_db.php

Expected: ✅ Database connection successful!

If you see: ❌ Connection failed: SQLSTATE[HY000] [1045] Access denied Check:

1. .env credentials
2. Users exist (users.sql executed)
3. db.sql imported into gogrocery

👉 If error mentions vlucas/phpdotenv missing, run:

composer require vlucas/phpdotenv
php connect_db.php

---

📂 Project Structure

gogrocery/
│── database/              # Database-related scripts
│   │── db.sql             # Database schema (tables, FKs, etc.)
│   │── users.sql          # Creates MySQL users + grants privileges
│   │── seed.sql           # Sample seed data (users, products, orders, etc.)
│
│── .env.example           # Template environment config
│── .env                   # Your environment file (not committed to git)
│── connect_db.php         # Database connection test
│── composer.json          # Composer dependencies
│── composer.lock          # Composer lockfile
│
│── public/                # Web root (accessible from browser)
│   │── index.php          # Main entry point
│   │── assets/            # Static files (images, JS, fonts, etc.)
│   │── css/               # CSS stylesheets
│       │── style.css      # Example main stylesheet
│
│── src/                   # PHP application code
│── vendor/                # Installed by Composer (ignored in git)

---

👥 Developer Notes

• Use root (or gogrocery_dev) for migrations/admin tasks.
• Use grocery_customer for website/frontend testing.
• Each developer must:
  1. Run users.sql as root
  2. Import db.sql
  3. Create .env
  4. Run composer install

---

💡 Best Practices

• Never commit your .env file.
• Use strong passwords for MySQL users.
• Keep composer.json minimal (only necessary dependencies).
• Run composer update sparingly (prefer composer install for stability).
• Use gogrocery_customer for app usage to avoid damaging schema.

---

🛠️ Troubleshooting

• Problem: "composer not recognized"
  → Add Composer to PATH or reinstall via installer.

• Problem: Access denied for user
  → Check .env matches users.sql credentials.
  → Ensure you imported users.sql as root.

• Problem: Database doesn't exist
  → Run CREATE DATABASE gogrocery; or re-import db.sql.

• Problem: Website loads blank page
  → Check Apache/PHP error logs.
  → Ensure vendor/ installed (run composer install).
  → Verify .env file exists and is correct.

---

📌 Minimal Commands Reference (Copy/Paste)

Linux/macOS

# clone
git clone  GoGrocery-Ecommerce
cd GoGrocery-Ecommerce

# install composer (if missing)
php -r "copy('https://getcomposer.org/installer','composer-setup.php');"
php composer-setup.php --install-dir=/usr/local/bin --filename=composer
php -r "unlink('composer-setup.php');"

# install packages
composer install

# import db & users & sample data
mysql -u root -p < database/db.sql
mysql -u root -p < database/users.sql
mysql -u root -p gogrocery < database/seed.sql

# secure env
chmod 600 .env

# test
php connect_db.php

# run dev server (optional)
php -S localhost:8000 -t public

Windows (PowerShell)

# clone
git clone  GoGrocery-Ecommerce
cd .\GoGrocery-Ecommerce\

# install composer: download Composer-Setup.exe and run it,
# then in a new terminal:
composer -V

# install packages
composer install

# import db using mysql.exe from WAMP (adjust path if needed)
# Example using mysql client bundled with WAMP:
& 'C:\wamp64\bin\mysql\mysql8.0.XX\bin\mysql.exe' -u root -p < database/db.sql
& 'C:\wamp64\bin\mysql\mysql8.0.XX\bin\mysql.exe' -u root -p < database/users.sql
& 'C:\wamp64\bin\mysql\mysql8.0.XX\bin\mysql.exe' -u root -p gogrocery < database/seed.sql

# create .env
notepad .env

# test
php connect_db.php

# start WAMP and visit in browser:
http://localhost/GoGrocery-Ecommerce/

---

💡 Extras & Best Practices

• Keep composer.json and composer.lock in git; ignore vendor/.
• Put db.sql in repo only if it’s small; large dumps should be distributed externally.
• Use different passwords for gogrocery_dev and gogrocery_customer.
• In production, use server-managed secrets (Docker env / system env / secret manager), not .env files.
• Do not run the app as root or use root DB user in production.

---

✅ Setup Complete – GoGrocery is now running locally! 🎉