Skip to content

BirdyDevs/promt-library

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Prompt Library

A web application to catalog and share AI prompts with others.

Features

  • Catalog AI prompts
  • Share prompts with others
  • User authentication
  • REST API (FastAPI)
  • PostgreSQL database
  • React frontend
  • Docker & docker-compose support

🚀 Quick Start

Option 1: Using Makefile (Recommended)

# Clone the repository
git clone <repository-url>
cd prompt-library

# Start the development environment
make dev

Option 2: Using Docker Compose

# Clone the repository
git clone <repository-url>
cd prompt-library

# Start all services
docker-compose up --build -d

🌐 Access Points

🛠️ Development Commands

The project includes a comprehensive Makefile for easy development:

# Show all available commands
make help

# Development
make dev          # Start development environment
make build        # Build all Docker containers
make up           # Start all services
make down         # Stop all services
make restart      # Restart all services

# Logs
make logs         # Show logs for all services
make logs-frontend # Show frontend logs only
make logs-backend  # Show backend logs only
make logs-db       # Show database logs only

# Database
make db-reset     # Reset database (WARNING: deletes all data)

# Cleanup
make clean        # Clean up Docker resources
make clean-all    # Clean up everything including images

# Status
make status       # Show status of all services

📁 Project Structure

  • backend/ — FastAPI backend
  • frontend/ — React frontend
  • docker-compose.yml — Orchestration
  • Makefile — Development commands

🛠️ Technology Stack

  • Backend: Python, FastAPI, SQLAlchemy
  • Frontend: React, Axios
  • Database: PostgreSQL
  • Containerization: Docker & Docker Compose

📝 Development Workflow

  1. Start development:

    make dev
  2. View logs:

    make logs
  3. Stop services:

    make down
  4. Reset database:

    make db-reset
    make dev

🔧 Troubleshooting

  • Port conflicts: The application uses ports 3001 (frontend), 8001 (backend), and 5433 (database)
  • Database issues: Use make db-reset to reset the database
  • Docker issues: Use make clean to clean up Docker resources

📄 License

MIT

About

runCMD

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors