Markdown Martha
b4be9d402d
- Add comprehensive 'About CartSnitch' section with mission statement - Expand developer section with tech stack details - Add infrastructure information (CloudNativePG, DragonflyDB, Better-Auth, Authentik) - Add key repositories table with new 'skills' repo - Include getting started resources for developers - Improve messaging to reflect CartSnitch's consumer savings focus Co-Authored-By: Paperclip <noreply@paperclip.ing>
79 lines
2.9 KiB
Markdown
79 lines
2.9 KiB
Markdown
<p align="center">
|
|
<img src="cartsnitch-logo.png" alt="CartSnitch" width="400" />
|
|
</p>
|
|
|
|
<div align="center">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<h3 align="center">Save money on every grocery trip.</h3>
|
|
|
|
<p align="center">
|
|
<strong>CartSnitch finds deals you'd miss. Never overpay for groceries again.</strong>
|
|
</p>
|
|
|
|
<p align="center">
|
|
We empower consumers to get the most value from what they spend at the grocery store.
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://cartsnitch.farh.net">Get Started</a>
|
|
·
|
|
<a href="https://cartsnitch.farh.net/docs">Help & Guides</a>
|
|
·
|
|
<a href="https://github.com/cartsnitch/.github/issues">Feedback</a>
|
|
</p>
|
|
|
|
---
|
|
|
|
## About CartSnitch
|
|
|
|
CartSnitch is a real-time grocery savings platform that monitors prices and deals across your favorite grocery stores. Our mission is to empower every shopper to save money without sacrificing convenience.
|
|
|
|
Save $50+ per month with deals you actually use. CartSnitch integrates with your shopping habits to surface relevant discounts, coupons, and price drops before you check out.
|
|
|
|
## How It Works
|
|
|
|
CartSnitch monitors prices and deals across your favorite grocery stores in real time. Savings that matter, when they matter.
|
|
|
|
### For Shoppers
|
|
- **Real-time deal alerts** — Never miss a sale on items you buy
|
|
- **Smart coupon matching** — One tap to find coupons for your cart
|
|
- **Grocery tracking** — Monitor prices and plan your shopping
|
|
|
|
### For Developers
|
|
CartSnitch is built on modern, scalable technology and welcomes community contributions.
|
|
|
|
#### Key Repositories
|
|
|
|
| Repository | Purpose |
|
|
|------------|---------|
|
|
| [cartsnitch](https://github.com/cartsnitch/cartsnitch) | Main application and consumer interface |
|
|
| [api](https://github.com/cartsnitch/api) | Backend API and services |
|
|
| [common](https://github.com/cartsnitch/common) | Shared libraries and utilities |
|
|
| [infra](https://github.com/cartsnitch/infra) | Infrastructure and deployment |
|
|
| [skills](https://github.com/cartsnitch/skills) | Custom skills and integrations |
|
|
|
|
#### Tech Stack
|
|
- **Backend**: Modern cloud-native architecture with CloudNativePG (Postgres)
|
|
- **Cache**: DragonflyDB for high-performance caching
|
|
- **Auth**: Better-Auth + OAuth2 with Authentik OIDC provider
|
|
- **Secrets**: Bitnami Sealed Secrets for secure credential management
|
|
- **Infrastructure**: Kubernetes-based deployments
|
|
|
|
#### Getting Started
|
|
- 📖 [Developer Documentation](https://cartsnitch.farh.net/docs)
|
|
- 🤝 [Contributing Guidelines](https://github.com/cartsnitch/.github/blob/main/CONTRIBUTING.md)
|
|
- 💬 [Community Discussions](https://github.com/orgs/cartsnitch/discussions)
|
|
|
|
---
|
|
|
|
<p align="center">
|
|
Built with ❤️ by the CartSnitch team
|
|
</p>
|