Skip to content

Commit 99ccea5

Browse files
committed
Merge branch 'main' of https://github.com/Rnbsov/celeste
2 parents 9652848 + a0ba548 commit 99ccea5

File tree

1 file changed

+51
-11
lines changed

1 file changed

+51
-11
lines changed

README.md

Lines changed: 51 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
<div align="center">
66
<h1>【 Celeste 】</h1>
7-
<h3></h3>
7+
<h3>Microgreens Tracking & Growth Management App</h3>
8+
89
</div>
910

1011
<div align="center">
@@ -21,19 +22,58 @@
2122
<h3></h3>
2223
</div>
2324

24-
# myapp
25+
## About Celeste
26+
27+
Celeste is a cross-platform application designed to simplify and systematize the process of monitoring microgreens growth, maintaining phenological records, and storing data for analysis and forecasting. Track your plant growth journey with ease!
28+
29+
## Key Features
30+
31+
### 🌱 Microgreens Batch Management
32+
33+
- Register new batches with detailed information
34+
- Track different types of microgreens (arugula, cress, mustard, etc.)
35+
- Record sowing dates, substrate types, and expected harvest dates
36+
37+
### 📝 Growth Journal
38+
39+
- Daily/periodic entries for monitoring progress
40+
- Photo uploads for visual comparison
41+
- Track metrics like sprout height, watering schedules, and lighting conditions
42+
43+
### 📊 Analytics
44+
45+
- Countdown to expected harvest date
46+
- Growth tracking and visualization
47+
- Moisture history recording
48+
49+
### 🔔 Notifications & Tips
50+
51+
- Custom reminders for watering and daily inspections
52+
- Quick tips to prevent mold and maintain optimal moisture levels
53+
54+
### 📚 Microgreens Library
55+
56+
- Database of popular varieties with growing recommendations
57+
- Standard guidelines for germination periods, temperature, and lighting
2558

26-
A new Flutter project.
59+
## Tech Stack
2760

28-
## Getting Started
61+
- **Frontend**: Flutter (iOS, Android, Web)
62+
- **Backend**: Python FastAPI backend ([celeste-backend](https://github.com/Rnbsov/celeste-backend))
63+
- Containerized with Docker for consistent deployment across environments
64+
- Uses [DragonFlyDB](https://www.dragonflydb.io/) (modern, faster Redis alternative) for high-performance caching
65+
- RESTful API endpoints with automatic OpenAPI documentation through modern Swagger alternative Scalar Api
66+
- **Admin Panel**: NextJs with styling using [Tailwind](https://tailwindcss.com/), modern components library [shadcn/ui](https://ui.shadcn.com/), animations using [motion (previously framer-motion)](https://motion.dev/) ([celeste-admin](https://github.com/Rnbsov/celeste-admin))
67+
- **Authentication**: Supabase Auth (with Google provider support)
68+
- **Database**: Supabase PostgreSQL
2969

30-
This project is a starting point for a Flutter application.
70+
## Continuous Integration / Continuous Deployment
3171

32-
A few resources to get you started if this is your first Flutter project:
72+
This project uses GitHub Actions to automate the build and release process:
3373

34-
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
35-
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
74+
- **Automatic APK Building**: Every push to the main/master branch triggers an APK build
75+
- **Release Creation**: APKs are automatically published as GitHub releases
76+
- **Version Tagging**: Releases are tagged with version from pubspec.yaml and build timestamp
77+
- **Release Notes**: Automatically generated release notes document changes
3678

37-
For help getting started with Flutter development, view the
38-
[online documentation](https://docs.flutter.dev/), which offers tutorials,
39-
samples, guidance on mobile development, and a full API reference.
79+
You can download the latest APK from the [Releases page](https://github.com/Rnbsov/celeste/releases).

0 commit comments

Comments
 (0)