Skip to content

Commit

Permalink
Update readme with todo list
Browse files Browse the repository at this point in the history
  • Loading branch information
daya0576 committed Jan 29, 2025
1 parent 8c9e9da commit 40b56b7
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 31 deletions.
58 changes: 29 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ To avoid [permission issues](https://github.com/daya0576/beaverhabits/discussion
| **FIRST_DAY_OF_WEEK**(int) | By default, the first day of the week is set as Monday. To change it to Sunday, you can set it as `6`. |
| **MAX_USER_COUNT**(int) | By setting it to `1`, you can prevent others from signing up in the future. |
| **ENABLE_IOS_STANDALONE**(bool) | Experiential feature to enable standalone mode on iOS. The default setting is `false`. |
| **INDEX_SHOW_HABIT_COUNT**(bool) | To display the total ticket count along with the habit name on the index page. The default setting is `false`. |
| **INDEX_SHOW_HABIT_COUNT**(bool) | To display total completed count along with the habit name on the index page. The default setting is `false`. |
| **TRUSTED_EMAIL_HEADER**(str) | Delegate authentication to an authenticating reverse proxy that passes in the user's details in HTTP headers, e.g. `Cf-Access-Authenticated-User-Email`. An existing account is required. |
| **TRUSTED_LOCAL_EMAIL**(str) | Disables authentication entirely. A new account with the specified email will be created if it does not exist. |

Expand All @@ -88,27 +88,34 @@ uv venv && uv sync

# Features

1. Pages
- [x] Index page
- [x] Habit list page
- [x] Order habits
- [x] Habit detail page
- [x] Calendar
- [x] Streaks
2. Storage:
- [x] Session-based disk storage
- [x] User-based disk storage
- [x] User-based db storage
3. CICD:
- [x] Custom domain
- [x] Self-hosting option
- [x] Unit tests & deployment pipeline
4. Others:
- [x] Export
- [x] Import
- [x] User management
- [x] User timezone
- [x] RESTful API
1. Habit Tracking
- [x] Daily notes/descriptions
- [ ] Measurable habits
- [ ] Multiple states
2. Pages & UI
- [x] Reorder habits
- [ ] Category or tag
- [ ] Light mode
- [ ] Standalone mode for iOS
- [ ] **Responsive layout** for desktop & mobile
- [ ] **Native mobile app**
3. Storage
- [x] Session-based disk storage (Demo only)
- [x] User-based disk storage
- [x] User-based db storage
4. CICD
- [x] Unit tests and deployment pipeline
- [x] Docker build and push pipeline
5. Authentication
- [x] Email & password
- [x] SSO Trusted email header
- [x] Disable authentication entirely
6. Extensibility
- [x] Export & Import
- [x] RESTful API
7. Others
- [ ] Habit calendar template, e.g. vacations


## Streaks
Here are my table tennis training sessions in the past year :)
Expand All @@ -130,10 +137,3 @@ Open page `/gui/order` to change the order of habits.
## Daily Notes
Press and hold to add a note or description for the day.

# Future Plans

1. Quantitative metrics
2. Native mobile app -- can't wait to try Swift or Tauri :p
3. Habit calendar template, e.g. vacations
4. Category or Folders
5. ...
4 changes: 2 additions & 2 deletions beaverhabits/frontend/habit_page.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ def card_title(title: str, target: str):


@contextmanager
def card(link: str | None = None, padding: float = 3, width: int = 350):
def card(link: str | None = None, padding: float = 3):
with ui.card().classes("gap-0 no-shadow items-center") as card:
card.classes(f"p-{padding}")
card.classes("w-full")
card.style(f"width: {width}px")
card.style("max-width: 350px")
if link:
card.classes("cursor-pointer")
card.on("click", lambda: redirect(link))
Expand Down

0 comments on commit 40b56b7

Please sign in to comment.