Skip to content

Commit

Permalink
More refactoring
Browse files Browse the repository at this point in the history
  • Loading branch information
caspii committed Jul 18, 2024
1 parent 4627ca4 commit 79fcbac
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 5 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@

DinkyDash is a simple, customizable dashboard designed to display family-oriented information such as recurring tasks, countdowns to special events, and daily rotations. It's perfect for mounting on a Raspberry Pi with a display in a common area of your home, providing at-a-glance information for all family members.

DinkyDash is great for quickly answering those questions that kids like to ask again and again and again and again.

- "How many days till Christmas?"
- "Who's turn is it to take the trash out?"
- "When is my birthday party?"

The dashboard shows:
- Today's date
- Recurring tasks or roles (e.g., who's turn it is to do the dishes)
Expand All @@ -17,7 +23,7 @@ DinkyDash is built with Flask and can be easily configured using a YAML file, ma

### Stack
- Backend: Python 3 with Flask
- Frontend: HTML5, CSS (Bootstrap 5), Vanilla JavaScript
- Frontend: HTML5 and CSS (Bootstrap 5)
- Configuration: YAML

### Key Components
Expand All @@ -27,6 +33,9 @@ DinkyDash is built with Flask and can be easily configured using a YAML file, ma
4. `run_app.sh`: Bash script to start the Flask application.

### Setup

**TODO: Complete this section**

1. Clone the repository to your Raspberry Pi.
2. Create a Python virtual environment and install dependencies:

Expand Down
2 changes: 1 addition & 1 deletion dinkydash.co/index.html → docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ <h2 class="display-4 lh-1">Perfect for families with kids</h2>
</div>
</div>
</body>
<!-- Fathom - beautiful, simple dinkydash.co analytics -->
<!-- Fathom - beautiful, simple analytics -->
<script src="https://cdn.usefathom.com/script.js" data-site="HLVHPKAZ" defer></script>
<!-- / Fathom -->
</html>
4 changes: 1 addition & 3 deletions templates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,6 @@
</div>
</div>

<!-- Fathom - beautiful, simple dinkydash.co analytics -->
<script src="https://cdn.usefathom.com/script.js" data-site="HLVHPKAZ" defer></script>
<!-- / Fathom -->

</body>
</html>

0 comments on commit 79fcbac

Please sign in to comment.