📄 docs: Update readme and dev checklist
🐞 fix: Clean up non-used files
This commit is contained in:
50
README.md
50
README.md
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user