The Raspberry Clock

A Mechanical Clock With a Web Interface

In this project I used Flask Dashboard Black as a backbone to run the cog wheels of a mechanical clock, using Raspberry-Pi and a stepper motor.

The Clock

The Mechanism

The Step Motor Setup

Want to see it in action? Here's a VIDEO

To setup the right time on the clock, use the clock's web interface to input the shown time. This clock knows the time, it's just not sure what time it displays. Once you tell it what is shown, it will quickly move the clock hands to the right position.

Black Dashboard Flask

Open-source Flask Dashboard crafted on top of a modern Bootstrap design. Designed for those who like bold elements and beautiful websites, Black Dashboard is ready to help you create stunning websites and web apps. Black Dashboard is built with over 50 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.

👉 Black Dashboard Flask - product page
👉 Black Dashboard Flask - LIVE Demo

Features

Have questions? Contact Support (Email & Discord) provided by AppSeed

Free Version	PRO Version	Custom Development
✓ Up-to-date dependencies	Everything in Free, plus:	Everything in PRO, plus:
✓ Best Practices	✅ Premium Bootstrap 5 Design	✅ 1mo Custom Development
✓ DB: SQLite, MySql	✅ `OAuth` for Github	✅ Team: PM, Developer, Tester
✓ DB Tools: ORM, Flask-Migrate	✅ `Extended User Model`	✅ Weekly Sprints
✓ Session-Based authentication	✅ `Users Roles`	✅ Technical SPECS
✓ `Docker`	✅ `Private REPO Access`	✅ Documentation
✓ `CI/CD` Flow via Render	✅ PRO Support - Email & Discord	✅ 30 days Delivery Warranty
✓ `Free Support`	✅ Deployment Assistance	-
---------------------------------	---------------------------------	---------------------------------
✓ LIVE Demo	🚀 LIVE Demo `PRO`	🛒 `Order`: $4,999 (GUMROAD)

✅ Start in `Docker`

👉 Step 1 - Download the code from the GH repository (using GIT)

$ git clone https://github.com/app-generator/flask-black-dashboard.git
$ cd flask-black-dashboard

👉 Step 2 - Start the APP in Docker

$ docker-compose up --build

Visit http://localhost:5085 in your browser. The app should be up & running.

✅ Create/Edit `.env` file

The meaning of each variable can be found below:

DEBUG: if True the app runs in develoment mode
- For production value False should be used
ASSETS_ROOT: used in assets management
- default value: /static/assets
OAuth via Github
- GITHUB_ID=<GITHUB_ID_HERE>
- GITHUB_SECRET=<GITHUB_SECRET_HERE>

✅ Manual Build

Download the code

$ git clone https://github.com/app-generator/flask-black-dashboard.git
$ cd flask-black-dashboard

👉 Set Up for `Unix`, `MacOS`

Install modules via VENV

virtualenv env
source env/bin/activate
pip3 install -r requirements.txt

Set Up Flask Environment, adn mock the gpio access

export FLASK_APP=run.py
export FLASK_ENV=development
export GPIOZERO_PIN_FACTORY=mock

Start the app

flask run
#// OR
#$ flask run --cert=adhoc # For HTTPS server

At this point, the app runs at http://127.0.0.1:5000/.

👉 Set Up for `Windows`

Install modules via VENV (windows)

$ virtualenv env
$ .\env\Scripts\activate
$ pip3 install -r requirements.txt

Set Up Flask Environment

$ # CMD 
$ set FLASK_APP=run.py
$ set FLASK_ENV=development
$
$ # Powershell
$ $env:FLASK_APP = ".\run.py"
$ $env:FLASK_ENV = "development"

Start the app

$ flask run
// OR
$ flask run --cert=adhoc # For HTTPS server

At this point, the app runs at http://127.0.0.1:5000/.

✅ Recompile SCSS

The SCSS/CSS files used to style the Ui are saved in the apps/static/assets directory. In order to update the Ui colors (primary, secondary) this procedure needs to be followed.

$ yarn # install modules
$ # # edit variables 
$ vi apps/static/assets/scss/black-dashboard/custom/_variables.scss 
$ gulp # SCSS to CSS translation

The _variables.scss content defines the primary and secondary colors:

$default:       #344675 !default; // EDIT for customization
$primary:       #e14eca !default; // EDIT for customization
$secondary:     #f4f5f7 !default; // EDIT for customization
$success:       #00f2c3 !default; // EDIT for customization
$info:          #1d8cf8 !default; // EDIT for customization
$warning:       #ff8d72 !default; // EDIT for customization
$danger:        #fd5d93 !default; // EDIT for customization
$black:         #222a42 !default; // EDIT for customization

✅ Codebase

The project is coded using blueprints, app factory pattern, dual configuration profile (development and production) and an intuitive structure presented bellow:

< PROJECT ROOT >
   |
   |-- apps/
   |    |
   |    |-- home/                           # A simple app that serve HTML files
   |    |    |-- routes.py                  # Define app routes
   |    |
   |    |-- authentication/                 # Handles auth routes (login and register)
   |    |    |-- routes.py                  # Define authentication routes  
   |    |    |-- models.py                  # Defines models  
   |    |    |-- forms.py                   # Define auth forms (login and register) 
   |    |
   |    |-- static/
   |    |    |-- <css, JS, images>          # CSS files, Javascripts files
   |    |
   |    |-- templates/                      # Templates used to render pages
   |    |    |-- includes/                  # HTML chunks and components
   |    |    |    |-- navigation.html       # Top menu component
   |    |    |    |-- sidebar.html          # Sidebar component
   |    |    |    |-- footer.html           # App Footer
   |    |    |    |-- scripts.html          # Scripts common to all pages
   |    |    |
   |    |    |-- layouts/                   # Master pages
   |    |    |    |-- base-fullscreen.html  # Used by Authentication pages
   |    |    |    |-- base.html             # Used by common pages
   |    |    |
   |    |    |-- accounts/                  # Authentication pages
   |    |    |    |-- login.html            # Login page
   |    |    |    |-- register.html         # Register page
   |    |    |
   |    |    |-- home/                      # UI Kit Pages
   |    |         |-- index.html            # Index page
   |    |         |-- 404-page.html         # 404 page
   |    |         |-- *.html                # All other pages
   |    |    
   |  config.py                             # Set up the app
   |    __init__.py                         # Initialize the app
   |
   |-- requirements.txt                     # App Dependencies
   |
   |-- .env                                 # Inject Configuration via Environment
   |-- run.py                               # Start the app - WSGI gateway
   |
   |-- ************************************************************************

✅ Black Dashboard Flask `PRO Version`

For more components, pages and priority on support, feel free to take a look at this amazing starter:

Black Dashboard is a premium Bootstrap Design now available for download in Django. Made of hundred of elements, designed blocks, and fully coded pages, Black Dashboard PRO is ready to help you create stunning websites and web apps.

👉 Black Dashboard PRO Flask - product page
- ✅ Enhanced UI - more pages and components
- ✅ Priority on support

Black Dashboard Flask - Open-source starter generated by AppSeed.

laudena/flask-black-dashboard