Apppublic

wardamalik883/ai-code-explainer

sourceHugging Faceupdated 3mo agoView on Hugging Face

0likes

App README

🧠 AI Code Explainer

Full Stack Project | Node.js + PostgreSQL + Gemini AI

📁 Project Structure

ai-code-explainer/
├── backend/
│   ├── server.js              ← Main Express server
│   ├── db/
│   │   ├── index.js           ← PostgreSQL connection
│   │   └── schema.sql         ← Database tables
│   ├── middleware/
│   │   └── auth.js            ← JWT verification
│   └── routes/
│       ├── auth.js            ← Register & Login
│       └── explain.js         ← AI explain + History
├── frontend/
│   ├── index.html             ← Main app page
│   ├── login.html             ← Login page
│   ├── register.html          ← Register page
│   ├── css/
│   │   ├── style.css          ← Shared styles
│   │   ├── app.css            ← Main app styles
│   │   └── auth.css           ← Login/Register styles
│   └── js/
│       ├── app.js             ← Main app logic
│       └── auth.js            ← Login/Register logic
├── .env                       ← Environment variables
├── package.json
└── README.md

⚙️ Setup — Step by Step

Step 1: Install Node.js

Download from: https://nodejs.org

Step 2: Install PostgreSQL

Download from: https://www.postgresql.org/download/

Step 3: Get Free Gemini API Key

1.Go to: https://aistudio.google.com
2.Click "Get API Key"
3.Copy the key

Step 4: Setup Database

Open pgAdmin or psql and run:

sql

CREATE DATABASE code_explainer_db;

Then connect to it and run the schema.sql file.

Step 5: Configure .env

Open .env file and fill in:

DB_PASSWORD=your_postgres_password
GEMINI_API_KEY=your_gemini_api_key_here

Step 6: Install Dependencies

Open terminal in project folder:

bash

npm install

Step 7: Run the Server

bash

npm start

Step 8: Open in Browser

Go to: http://localhost:3000

🔑 API Endpoints

Method	Endpoint	Description
POST	/api/auth/register	Register new user
POST	/api/auth/login	Login user
POST	/api/explain	Explain code (protected)
GET	/api/explain/history	Get user history
DELETE	/api/explain/history/:id	Delete history item

🛠️ Tech Stack

Layer	Technology
Frontend	HTML5, CSS3, JS
Backend	Node.js + Express
Database	PostgreSQL
AI	Google Gemini API
Auth	JWT + bcryptjs

Made with ❤️ for Aptech Assignment