|
1 | | -# CodeHeart 💙 |
| 1 | +# CodeHeart |
2 | 2 |
|
3 | | -> Würdevoll spenden, direkt helfen / Donate with dignity, help directly |
| 3 | +> Dignified donations through a simple codeword system |
4 | 4 |
|
5 | | -CodeHeart is a digital donation platform that connects donors with homeless individuals through an innovative codeword system, preserving dignity and ensuring safety for all participants. |
| 5 | +CodeHeart is a digital donation platform connecting donors with homeless individuals through unique codewords (e.g., "Maria47"). Donors can support specific individuals without direct interaction, preserving dignity for all. |
6 | 6 |
|
7 | | -## 🌟 Vision |
| 7 | +## Current Status: Prototype |
8 | 8 |
|
9 | | -We're revolutionizing homeless assistance by creating a secure, anonymous, and dignified way to help those in need. Our codeword system allows donors to support individuals without direct interaction, reducing social pressure and safety concerns. |
| 9 | +The prototype is fully functional with mock data, demonstrating the complete user experience. |
10 | 10 |
|
11 | | -## 🚀 Current Status: Prototype Phase |
| 11 | +### What's Working |
12 | 12 |
|
13 | | -We're building a fully-functional mock-up with fake data to demonstrate the concept to stakeholders, investors, and potential users. This prototype-first approach allows us to: |
| 13 | +- Landing page with features, stats, and waitlist |
| 14 | +- User registration and login (mock auth) |
| 15 | +- Donor dashboard with donation history |
| 16 | +- Codeword search and donation flow |
| 17 | +- Beneficiaries listing with filters (location, needs) |
| 18 | +- German/English translations |
| 19 | +- Light/Dark theme |
| 20 | +- 25 automated tests |
14 | 21 |
|
15 | | -- Validate the user experience with all stakeholder types |
16 | | -- Demonstrate the vision clearly |
17 | | -- Gather feedback early |
18 | | -- Build investor confidence |
| 22 | +## Tech Stack |
19 | 23 |
|
20 | | -## 🛠️ Tech Stack |
| 24 | +| Layer | Technology | |
| 25 | +| --------- | ----------------------------- | |
| 26 | +| Framework | Next.js 14 | |
| 27 | +| Language | TypeScript | |
| 28 | +| Styling | Tailwind CSS, shadcn/ui | |
| 29 | +| State | Zustand + localStorage | |
| 30 | +| i18n | next-intl | |
| 31 | +| Testing | Vitest, React Testing Library | |
| 32 | +| CI/CD | GitHub Actions | |
21 | 33 |
|
22 | | -- **Frontend**: Next.js 14, TypeScript, Tailwind CSS, shadcn/ui |
23 | | -- **State Management**: Zustand (for prototype) |
24 | | -- **Internationalization**: next-intl (German & English) |
25 | | -- **Theme**: Light/Dark mode support |
26 | | -- **Future Backend**: Supabase, Stripe |
27 | | - |
28 | | -## 🏃♂️ Getting Started |
| 34 | +## Getting Started |
29 | 35 |
|
30 | 36 | ```bash |
31 | | -# Clone the repository |
32 | | -git clone https://github.com/[your-org]/codeheart.git |
33 | | - |
34 | | -# Install dependencies |
| 37 | +# Clone |
| 38 | +git clone https://github.com/moinsen-dev/codeheart.git |
35 | 39 | cd codeheart |
| 40 | + |
| 41 | +# Install |
36 | 42 | npm install |
37 | 43 |
|
38 | | -# Run the development server |
| 44 | +# Development |
39 | 45 | npm run dev |
40 | 46 | ``` |
41 | 47 |
|
42 | | -Open [http://localhost:3000](http://localhost:3000) to see the prototype. |
| 48 | +Open http://localhost:3000 |
43 | 49 |
|
44 | | -## 🤝 Contributing |
| 50 | +## Available Scripts |
45 | 51 |
|
46 | | -We welcome contributions from developers, designers, social workers, and anyone passionate about making a difference! Please see our [Contributing Guidelines](CONTRIBUTING.md). |
| 52 | +```bash |
| 53 | +npm run dev # Start dev server |
| 54 | +npm run build # Production build |
| 55 | +npm run test # Run tests in watch mode |
| 56 | +npm run test:run # Run tests once |
| 57 | +npm run lint # ESLint |
| 58 | +npm run format # Prettier |
| 59 | +``` |
47 | 60 |
|
48 | | -### Stakeholder Roles |
| 61 | +## Project Structure |
49 | 62 |
|
50 | | -- **Donors**: Individuals who want to help |
51 | | -- **Social Workers**: Verify and support beneficiaries |
52 | | -- **Investors/Sponsors**: Provide funding and resources |
53 | | -- **Partner Organizations**: Offer infrastructure and services |
54 | | -- **Developers**: Build and improve the platform |
55 | | -- **Testers**: Ensure quality and accessibility |
| 63 | +``` |
| 64 | +src/ |
| 65 | +├── app/[locale]/ # Pages with locale routing |
| 66 | +│ ├── page.tsx # Landing page |
| 67 | +│ ├── login/ # Authentication |
| 68 | +│ ├── register/ |
| 69 | +│ ├── dashboard/ # Donor dashboard |
| 70 | +│ ├── donate/ # Codeword search |
| 71 | +│ │ └── [codeword]/ # Donation form |
| 72 | +│ └── beneficiaries/ # Listing with filters |
| 73 | +├── components/ |
| 74 | +│ ├── ui/ # shadcn components |
| 75 | +│ └── __tests__/ # Component tests |
| 76 | +├── lib/ |
| 77 | +│ └── stores/ # Zustand store |
| 78 | +└── i18n/ # Locale configuration |
| 79 | +``` |
56 | 80 |
|
57 | | -## 📋 Roadmap |
| 81 | +## Roadmap |
58 | 82 |
|
59 | 83 | ### Phase 1: Prototype (Current) |
60 | 84 |
|
61 | | -- [x] Basic project setup |
62 | | -- [x] Theme & language switching |
63 | | -- [x] Landing page design |
64 | | -- [ ] Mock authentication |
65 | | -- [ ] Donor dashboard |
66 | | -- [ ] Beneficiary profiles |
| 85 | +- [x] Landing page |
| 86 | +- [x] Theme and language switching |
| 87 | +- [x] Mock authentication |
| 88 | +- [x] Donor dashboard |
| 89 | +- [x] Codeword donation flow |
| 90 | +- [x] Beneficiaries listing |
| 91 | +- [x] Testing infrastructure |
67 | 92 | - [ ] Social worker portal |
| 93 | +- [ ] Admin interface |
68 | 94 |
|
69 | 95 | ### Phase 2: MVP |
70 | 96 |
|
71 | 97 | - [ ] Supabase integration |
72 | 98 | - [ ] Real authentication |
73 | | -- [ ] Payment processing (Stripe) |
| 99 | +- [ ] Stripe payments |
74 | 100 | - [ ] GDPR compliance |
75 | 101 | - [ ] Security audit |
76 | 102 |
|
77 | 103 | ### Phase 3: Launch |
78 | 104 |
|
79 | | -- [ ] Partner onboarding |
80 | 105 | - [ ] Pilot in Hamburg |
81 | | -- [ ] Scale to 5 German cities |
82 | | - |
83 | | -## 🔒 Security & Privacy |
84 | | - |
85 | | -CodeHeart is designed with privacy-first principles: |
86 | | - |
87 | | -- No direct personal data exchange |
88 | | -- Time-delayed payouts for safety |
89 | | -- GDPR/DSGVO compliant |
90 | | -- End-to-end encryption for sensitive data |
91 | | - |
92 | | -## 📊 Impact Goals |
93 | | - |
94 | | -- **89%** of donations reach beneficiaries directly |
95 | | -- **<3 seconds** page load time |
96 | | -- **5+ languages** supported |
97 | | -- **100% GDPR** compliant |
98 | | - |
99 | | -## 🌍 Internationalization |
100 | | - |
101 | | -Currently supporting: |
| 106 | +- [ ] Partner onboarding |
| 107 | +- [ ] Expand to 5 German cities |
102 | 108 |
|
103 | | -- 🇩🇪 German (default) |
104 | | -- 🇬🇧 English |
| 109 | +## Contributing |
105 | 110 |
|
106 | | -Planning to add more languages based on community needs. |
| 111 | +See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. |
107 | 112 |
|
108 | | -## 📝 License |
| 113 | +## Documentation |
109 | 114 |
|
110 | | -This project is open source and available under the [MIT License](LICENSE). |
| 115 | +- [Product Requirements](docs/PRD.md) |
| 116 | +- [Database Architecture](docs/architecture/DATABASE_ARCHITECTURE.md) |
| 117 | +- [GDPR Compliance](docs/compliance/GDPR_DSGVO_COMPLIANCE.md) |
| 118 | +- [Development Plan](docs/setup/prototype_first_development_plan.md) |
111 | 119 |
|
112 | | -## 💌 Contact |
| 120 | +## License |
113 | 121 |
|
114 | | -- Website: [codeheart.org](#) (coming soon) |
115 | | - |
116 | | -- Join our [Discord](#) community |
| 122 | +MIT |
117 | 123 |
|
118 | 124 | --- |
119 | 125 |
|
120 | | -Made with ❤️ for those in need |
| 126 | +Made with care for those in need |
0 commit comments