Skip to content

jcar787/prompthub

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PromptHub

Summary

AI-powered summarization platform — write notes, get concise summaries, and view or edit them via a modern React UI.


Stack

Layer Technology
Frontend React + TypeScript + TailwindCSS (v4)
Backend Node.js + Express + TypeScript
ORM Drizzle ORM (PostgreSQL)
AI OpenAI (gpt-4o-mini)
Infrastructure Docker + Docker Compose

Local Setup (no Docker)

Backend

  1. Navigate to the server directory:

     cd server
    
  2. Copy the environment file and add your OpenAI API key & database credentials:

     cp .env.example .env
    
  3. Install dependencies and start the server:

     npm install
     npm run dev
    

Frontend

  1. Navigate to the client directory:

     cd client
    
  2. Install dependencies and start the development server:

     npm install
     npm run dev
    

Run with Docker Compose

At the project root:

docker compose up --build

This starts:

  • db → PostgreSQL database
  • api → Express backend on port 5050
  • (NOT YET) client → React frontend on port 5173

Access the application:


Environment Variables

File: server/.env

DB_HOST=db
DB_PORT=5432
DB_USER=postgres
DB_PASS=postgres
DB_NAME=prompthub
OPENAI_API_KEY=sk-your-key-here
NODE_ENV=dev|production

API Endpoints

Method Route Description
GET /api/summaries List all summaries
GET /api/summaries/:id Get a single summary
POST /api/summaries Create summary (LLM-powered)
PUT /api/summaries/:id Update an existing summary
DELETE /api/summaries/:id Delete a summary

Future Improvements

  • Add authentication
  • Dockerize the frontend
  • Add database readiness health checks
  • Add "Regenerate with AI" functionality

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published