EBAOH 🎯

EBAOH Logo

Project overview 🌟

EBAOH is a social network built around products, helping buyers make smarter decisions by gathering opinions from friends and the wider community.
You can recommend products, share experiences, create comparison surveys, and build a trusted reviewer network! 🛒📝

Technical stack 🛠️

Version 1

Framework: CodeIgniter 4 (PHP) ⚙️
Database: MySQL / MariaDB 🗄️
APIs:
- Facebook API (social login and content sharing) 🔗
- Buscapé API (product data) 📦

Version 2 (planned 🚀)

Language: PHP (framework to be decided) 🤔
Database: MySQL / MariaDB
APIs:
- Facebook API
- Buscapé API

Installation ⚡

Requirements 📋

PHP 7.4 or higher
MySQL 5.7+ or MariaDB 10.2+
Composer 📦
Node.js and NPM (for frontend assets) 🌐

Setup instructions 🛠️

Clone the repository:

git clone https://github.com/guibranco/ebaoh.git
cd ebaoh

Install PHP dependencies:
```
composer install
```

Configure your environment:

Copy the example environment file:
```
cp env .env
```

Update your .env with database credentials:

database.default.hostname = localhost
database.default.database = ebaoh
database.default.username = youruser
database.default.password = yourpassword

Set up API keys:

facebook.app_id = your_app_id
facebook.app_secret = your_app_secret
buscape.api_key = your_buscape_api_key

Run database migrations:
```
php spark migrate
```
(Optional) Seed your database 🌱:
```
php spark db:seed InitialSeeder
```
Start the development server 🚀:
```
php spark serve
```

Project structure 🏗️

Core components 🧩

User module: Registration, login, profiles, social connections 👤
Product module: Product listings, recommendations, comments 🛍️
Survey module: Product comparison surveys and voting 📊
Social integration: Facebook login and sharing 📱
Ranking system: User credibility levels based on engagement ⭐

Database schema overview 🗃️

users: User accounts and profiles
products: Product details from Buscapé
recommendations: User recommendations
surveys: Product surveys
votes: Survey votes
comments: Product and survey comments
friendships: Friendships between users
follows: Following users or products
activities: Activity tracking for rankings

Features ✨

User accounts:
- Register, login, manage profiles 👥
Product management:
- Search and browse products 📦
- Recommend, comment, and upload photos 📷
Surveys:
- Create product comparisons 📊
- Vote and comment 🗳️
Social features:
- Add friends, follow users and products 👯‍♂️
- Get real-time updates 🔔
Ranking system:
- Earn credibility as you engage 📈
Social media integration:
- Share your activities on Facebook 🌍
Updates feed:
- Stay in the loop with your friends’ actions 📰

API integrations 🔌

Facebook API

Social login ✅
Connect with friends 👥
Share activities to the Facebook wall 📰

Buscapé API

Search products 🔎
Retrieve product details and specs 🛍️
Access product images 📷

Development guidelines 📚

Coding standards

Follow PSR-12 coding style ✍️
Use CodeIgniter 4 conventions for Version 1

Contributing 🤝

Create a feature branch:

git checkout -b feature/amazing-feature

Commit your changes:

git commit -m 'Add some amazing feature'

Push to GitHub:

git push origin feature/amazing-feature

Open a Pull Request 🚀

Testing 🧪

Run PHPUnit tests:

./vendor/bin/phpunit

Deployment 🚀

Production requirements

PHP 7.4+ with required extensions ⚙️
MySQL 5.7+ or MariaDB 10.2+
Web server (Apache or Nginx) 🌐
SSL certificate (required for Facebook API) 🔒

Deployment steps

Clone the repository on your server
Set the web server document root to the public/ folder
Install dependencies:
```
composer install --no-dev
```
Set up production environment variables
Run migrations:
```
php spark migrate
```
Set correct file permissions 🛡️

Future plans (V2) 🔮

Choose the best framework for V2 ⚙️
Optimize mobile experience 📱
Expand API integrations 🔌
Boost performance 🚀
Develop smarter recommendation algorithms 🧠

License 📄

Distributed under the MIT License.