---

📌 Overview

Zenly is an open source, full-stack platform supporting student mental well-being with:

• AI-powered journaling & reflections (SSE)
• Mood tracking with profile insights and charts
• Community forum (posts, comments, real-time updates)
• Curated resource hub (live helpful/view counts)
• Admin dashboard with moderation, alerts, user management

Built in a modern Next.js (App Router) frontend, backed by a robust Express/PostgreSQL API.

---

✨ Features

• 📝 Journals with AI analysis — Streamed progress and personalized reflections
• 📈 Mood tracking — Profile insights, Recharts line graphs, daily ratings
• 🧑‍🤝‍🧑 Community forum — Posts, comments, likes, reporting, real-time via Socket.IO
• 🔗 Curated resources — Featured, search, live helpful/view counts
• 🛡️ Admin — Moderation, risk alerts, secure elevation flow
• 📰 Recent activity feed — Journals, resource views, forum posts
• 🚀 Real-time updates — Seamless with Socket.IO & SSE

---

📦 Installation

Fork the repo
git clone https://github.com/YourUsername/Zenly.git
cd Zenly

Copy env file and fill out your secrets
cp backend/.env.example backend/.env

Start both servers (FE + BE)
./start-dev.sh

• Backend runs at: http://localhost:5001
• Frontend runs at: http://localhost:3000

---

▶️ Usage

Start Development:

./start-dev.sh

• Installs dependencies

• Runs backend & frontend servers

API Endpoints: See API Overview for routes and usage.

---

🐛 Troubleshooting

• CORS errors → Set FRONTEND_URL in backend .env
• Token issues → Auto-refresh is handled; if stuck, login again
• SSE/Socket.IO not streaming → Ensure proxy allows streaming, CORS whitelists are correct

---

🗂️ Monorepo Structure

Zenly/
├── backend/ # Express API, Socket.IO, SSE
│ ├── server.js
│ ├── config/
│ ├── controllers/
│ ├── middleware/
│ ├── models/
│ ├── routes/
│ └── services/
├── frontend/ # Next.js 14 app (App Router)
│ ├── app/
│ ├── components/
│ ├── hooks/
│ ├── lib/
│ └── public/
├── start-dev.sh # One-command dev start (FE+BE)
├── package.json # Root scripts (dev, build, lint, bdev)
└── README.md

---

⚙️ Configuration

Backend (backend/.env):

• SUPABASE_URL — Your Supabase project URL
• SUPABASE_SERVICE_ROLE_KEY — Your Supabase service role API key
• PORT — API port
• FRONTEND_URL — Allowed CORS origin
• JWT_ACCESS_SECRET, JWT_REFRESH_SECRET — JWT secrets
• ...and more for emails, AI, admin, see .env.example

Frontend (frontend/.env.local)

• NEXT_PUBLIC_API_URL — API base

---

🌐 API Overview (high-level)

• Auth (/auth): Signup, OTP, login, password reset, admin elevation
• Journals (/journals): CRUD, stats, analysis (SSE), AI messages
• Moods (/moods): Today's update, profile chart
• Forum (/forum): Posts, comments, likes, reports
• Resources (/resources): Featured, search, helpful/view count, admin CRUD
• Notifications/Activity: Recent events, notifications

See code for full endpoints and sample payloads.

---

🚦 Real-time & Streaming

• Socket.IO: Real-time forum & resources rooms
• SSE: Streaming for journal analysis, AI chat

---

📋 Roadmap

• Email flows (password reset, onboarding)
• File uploads (avatars, attachments)
• Production deployment guides (Vercel, Railway, Render, Fly.io)
• Monitoring, error tracking

---

🔒 License

Zenly is open source under the MPL-2.0 License (Mozilla Public License Version 2.0).
See LICENSE for details.

While commercial use is technically allowed under MPL-2.0, we kindly discourage commercialization of Zenly. Please use this project for learning, personal growth, and community benefit.

---

🤝 Contributing & Community

• Please read our Contributing Guide for setup, workflow, and PR expectations
• See our Code of Conduct for community standards

---