https://github.com/cyrus-nodejs/foodpal-api
FoodPal Nodejs Express API
https://github.com/cyrus-nodejs/foodpal-api
Last synced: 3 months ago
JSON representation
FoodPal Nodejs Express API
- Host: GitHub
- URL: https://github.com/cyrus-nodejs/foodpal-api
- Owner: cyrus-nodejs
- Created: 2026-02-11T00:14:58.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-02-11T00:41:33.000Z (4 months ago)
- Last Synced: 2026-02-11T04:01:03.000Z (4 months ago)
- Language: TypeScript
- Homepage:
- Size: 124 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🍲 FoodPal Backend
**FoodPal** is an intelligent cooking companion that blends **AI recipe recommendations**, **community engagement**, and **personalized nutrition** — tailored for the modern African kitchen 🇳🇬.
This backend powers all API endpoints, authentication, gamification, and real-time cook-along sessions.
---
## 🚀 Features
### 👤 Authentication & Users
- Email/password + Google OAuth login
- JWT-based authentication
- User profiles with dietary preferences, cooking habits & cultural background
### 🧠 AI-Powered Recipe Recommendations
- Personalized "For You" feed using OpenAI embeddings
- Smart search & filtering (diet, culture, skill level)
### 🧑🏾🍳 Cook-Along (Live)
- WebSocket-powered **live cook-along chat + timer**
- Users can join cooking sessions and message in real time
### 🍱 Meal Planning
- AI-generated weekly meal plans
- Smart substitutions for allergies and budget
### 🌍 Community
- Share recipes, like, comment, and discuss
- Social-style interaction among food lovers
### 🥕 Nutrition
- Ingredient-based nutrition breakdown
- Calorie and macro tracking
### 🏅 Gamification (New!)
- Cooking streaks tracking
- Achievement badges (`"Budget Chef"`, `"Zero-Waste Pro"`, etc.)
- Weekly cooking challenges (e.g., *“5 Meals Under ₦2000”*)
---
## 🧩 Tech Stack
| Category | Tech |
|-----------|------|
| **Runtime** | Node.js (TypeScript) |
| **Framework** | Express.js |
| **Database** | MongoDB + Mongoose |
| **Auth** | JWT + Google OAuth2 |
| **AI Integration** | FastAPI | Transformers
| **Real-Time** | Socket.io |
| **Cache/Scaling (optional)** | Redis |
| **Docs** | Swagger (OpenAPI 3.0) |
---
## 🗂️ Folder Structure
```
backend/
├── controllers/
│ ├── authController.ts
│ ├── userController.ts
│ ├── mealPlanController.ts
│ ├── communityController.ts
│ ├── cookAlongController.ts
│ ├── nutritionController.ts
│ └── gamificationController.ts
│
├── models/
│ ├── user.ts
│ ├── userPreference.ts
│ ├── recipe.ts
│ ├── communityPost.ts
│ ├── mealPlan.ts
│ └── gamification/
│ ├── streak.ts
│ ├── badge.ts
│ └── challenge.ts
│
├── routes/
│ ├── authRoutes.ts
│ ├── userRoutes.ts
│ ├── mealPlanRoutes.ts
│ ├── communityRoutes.ts
│ ├── cookAlongRoutes.ts
│ ├── nutritionRoutes.ts
│ └── gamificationRoutes.ts
│
├── middleware/
│ └── authMiddleware.ts
│
├── utils/
│ ├── sendEmail.ts
│ └── embedding.ts
│
├── config/
│ └── db.ts
│
├── swagger.json
├── app.ts
└── server.ts
```
---
## ⚙️ Environment Variables
Create a `.env` file in your project root:
```bash
PORT=5000
MONGO_URI=mongodb+srv://:@cluster.mongodb.net/yourdb
JWT_SECRET=
JWT_EXPIRES=7d
OPENAI_API_KEY=
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
REDIS_URL=
FRONTEND_URL=http://localhost:3000
```
# 1️⃣ Clone the repo
git clone https://github.com//FoodPal-backend.git
cd FoodPal-backend
# 2️⃣ Install dependencies
npm install
# 3️⃣ Run development server
npm run dev
# 4️⃣ For production
npm run build
npm start
🧪 API Documentation
Swagger UI is available at:
It includes:
/api/auth → Login, Register, Google Auth
/api/users → Profile management
/api/mealplans → AI meal planner
/api/community → Posts, likes, comments
/api/cookalong → Live cooking chat
/api/nutrition → Nutrition facts
/api/gamification → Streaks, badges, challenges
🧡 Credits
Built with love by the FoodPal Team — inspiring creativity and connection through food.
🍛 “Cook smarter, not harder.”
📜 License
This project is licensed under the MIT License.
MIT © 2025 FoodPal