Self-Hosted • Open Source • Docker-First • Built for Churches & Small Business
🚀 Quick Start • ✨ Features • 🎨 Branding • 📖 Docs • 📦 Deploy • 🤝 Contribute
|
Fast, intuitive checkout with barcode scanning, variants, and real-time inventory |
Comprehensive reports, sales tracking, and business insights |
Click to expand
- Website (Coming Soon)
- Documentation (Coming Soon)
- Demo (Coming Soon)
- GitHub Issues - Report bugs or request features
- Branding Guidelines - Logo usage and brand assets
The fastest way to get started - everything you need in one command!
# Clone the repository
git clone https://github.com/24Skater/stewardpos.git
cd stewardpos
# Start all services
docker-compose up -d
# 🎉 That's it! Open http://localhost:8080📋 First Time Setup
- Open
http://localhost:8080 - Complete the setup wizard:
- Create admin account
- Configure database
- Set authentication methods
- Login with your credentials
- Start selling!
Default Demo Credentials:
Email: admin@demo.local
Password: admin123
Backend Setup
cd backend
npm install
cp env.example .env # Configure your settings
npm run setup-db # Run migrations
npm run dev # Start server at :3001Frontend Setup
npm install
npm run dev # Start dev server at :5173
|
|
|
|
|
|
|
|
|
StewardPOS uses Clean Architecture with the Ports and Adapters pattern:
┌─────────────────────────────────────────────────────────────────┐
│ FRONTEND │
│ React 18 • TypeScript • Vite • shadcn/ui │
├─────────────────────────────────────────────────────────────────┤
│ API │
│ Express • JWT Auth • Zod Validation │
├─────────────────────────────────────────────────────────────────┤
│ BUSINESS LOGIC │
│ Domain Models • Use Cases • Ports │
├─────────────────────────────────────────────────────────────────┤
│ ADAPTERS (Pluggable) │
│ ┌────────────┬────────────┬────────────┬────────────┐ │
│ │ Database │ Auth │ Email │ Storage │ │
│ ├────────────┼────────────┼────────────┼────────────┤ │
│ │ PostgreSQL │ Local │ SMTP │ S3 │ │
│ │ SQLite │ Google │ Resend │ Azure │ │
│ │ IndexedDB │ OIDC │ Console │ Local │ │
│ └────────────┴────────────┴────────────┴────────────┘ │
└─────────────────────────────────────────────────────────────────┘
🎯 Why This Architecture?
| Benefit | Description |
|---|---|
| Swappable | Change databases/auth without touching business logic |
| Testable | Mock adapters for comprehensive unit tests |
| Extensible | Add new providers by implementing interfaces |
| Configurable | Switch adapters via environment variables |
|
|
|
|
Recommended docker-compose up -d |
Ubuntu • Debian • CentOS systemd service nginx proxy |
Server 2019+ • Win10/11 PowerShell script IIS support |
AWS • Azure • GCP DigitalOcean • more Container ready Auto-scaling |
Make stewardPOS your own with comprehensive branding options:
|
Configure your business details that appear across the system:
|
Create professional, branded receipts:
Brand color automatically updates:
|
Tip: Go to Admin → Branding to customize all these options with a live preview!
|
Found a security issue? Please report privately: 📧 Email: security@stewardpos.dev Do not open public issues for security vulnerabilities. See SECURITY.md for details. |
We welcome contributions! Here's how to get started:
# 1. Fork & clone
git clone https://github.com/YOUR_USERNAME/stewardpos.git
# 2. Install dependencies
npm install && cd backend && npm install
# 3. Create a branch
git checkout -b feature/amazing-feature
# 4. Make changes, then commit
git commit -m "feat: add amazing feature"
# 5. Push and open a PR
git push origin feature/amazing-feature📋 Contribution Guidelines
- Check open issues first
- Follow our code style (ESLint + Prettier)
- Write tests for new features
- Update documentation as needed
- Use conventional commits
|
|
|
|
This project was born out of a real need at my church. We needed a simple, reliable point-of-sale system for our bookstore and events, but most solutions were either too expensive or too complicated for our volunteers to use. So I built stewardPOS — not just as software, but as an act of service.
While stewardPOS works great for any retail business, it was designed with churches, ministries, and non-profits in mind:
Every feature, every line of code was written as unto the Lord. My hope is that this tool blesses your ministry the way building it has blessed mine. — The stewardPOS Team |
This project is licensed under the MIT License - see LICENSE for details.
| ✅ Commercial use | ✅ Modification | ✅ Distribution | ✅ Private use |
Special thanks to all our contributors!
Made with ❤️ and 🙏 for the glory of God
Quick Start • Documentation • Contribute • Back to Top ↑