Skip to content

YahiaJouini/Educonnect

Repository files navigation

EduConnect – Setup & Run Guide

This repository contains both the frontend and backend for EduConnect.
Follow the instructions below to get the project running locally.


📦 Requirements

  • Node.js ≥ 18.x or Bun (runtime alternatives)
  • npm or yarn (package managers)
  • PostgreSQL (for the backend database)
  • Supabase account (used for auth & realtime features, but without the Supabase client for fetching data)
  • Hugging Face account (for AI integrations)
  • PDF.co account (for PDF-related services)

🔑 Environment Variables

Create a .env file in project root directory with the following keys:

.env

NEXT_PUBLIC_SUPABASE_URL=
NEXT_PUBLIC_SUPABASE_ANON_KEY=
NEXT_PUBLIC_URL=
DATABASE_URL=
JWT_SECRET=
SUPABASE_SERVICE_ROLE_KEY=
HUGGINGFACE_API_TOKEN=
PDFCO_API_KEY=

Note: The project uses Supabase only for authentication and realtime, but does not rely on the Supabase client for fetching data. All data fetching is handled through our own backend API.

🖥 Installation

Clone the repository:

git clone https://github.com/YahiaJouini/educonnect.git

Install dependencies:

cd educonnect
npm install

🗄 Database Setup

npm run db:generate
npm run db:migrate

🚀 Running Locally

npm run dev

🛠 Production Build

npm run build
npm run start

Project runs on http://localhost:3000 by default.