📄 docs: Update readme and dev checklist

🐞 fix: Clean up non-used files
This commit is contained in:
Keith Solomon
2025-07-29 12:29:50 -05:00
parent 3c5b52c294
commit 0abe4f621b
11 changed files with 83 additions and 430 deletions

View File

@@ -22,13 +22,44 @@ PromptBase is a centralized, searchable repository for storing and managing prom
- User auth and profiles
- Prompt favorites and contributions
- Ratings, version history, and sharing
- External API access
## Usage
You'll need a .env file with your Supabase credentials. See `supabase.env.example`.
### Docker
To run the app using Docker, you can use the provided `docker-compose.yml` file.
```yaml
services:
frontend:
container_name: PromptBase
image: git.keithsolomon.net/keith/promptbase:main
restart: unless-stopped
environment:
- NODE_ENV=production
ports:
- "4321:4321"
volumes:
- ./.env:/app/.env:ro # Bind-mount .env as read-only
```
### To run locally (for development)
```bash
npm install
npm run dev
```
## Tech Stack
- **Frontend**: Astro + HTMX + Alpine.js (AHA Stack)
- **Frontend**: Astro js, Tailwind CSS
- **Backend**: Supabase (self-hosted)
- **Deployment**: Vercel or Netlify (frontend), Supabase (backend)
- **Deployment**: Docker (frontend), Supabase (backend)
## Database Schema
@@ -48,7 +79,7 @@ PromptBase is a centralized, searchable repository for storing and managing prom
## Development Roadmap
Development is organized into phases. For details, see `Development Checklist.md`.
Development is organized into phases. For details, see `checklist.md`.
### MVP Phases
@@ -66,17 +97,6 @@ Development is organized into phases. For details, see `Development Checklist.md
- Ratings, version control, external API
- Shareable links and embeds
## Usage
To run locally:
```bash
npm install
npm run dev
```
You'll need a .env file with your Supabase credentials. See `supabase.env.example`.
## Contributing
Pull requests are welcome! Please keep contributions focused on core functionality and usability improvements.