Skip to content
darkcnightPublic

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Latest commit

 

History

26 Commits

Folders and files

Repository files navigation

Pash - Personal Dashboard

PWA

Pash is a minimalist personal dashboard for your browser. It integrates Google Calendar, Google Tasks, a local notes app with rich text editing, a weather widget (optional), and a clock. Everything is handled client-side; no server or backend is required. Pash is also a Progressive Web App (PWA) that can be installed on your desktop or mobile device.


Features

  • ★ View your Google Calendar events
  • ★ Manage your Google Tasks
  • ★ Create and edit rich-text notes (powered by Quill.js)
  • ★ Display current weather (requires OpenWeatherMap API key)
  • ★ Live clock (uses system timezone automatically)
  • ★ Dark mode and light mode themes
  • ★ Persistent settings saved in your browser (localStorage)
  • ★ No backend required
  • ★ PWA support - install on desktop or mobile
  • ★ Rearrangeable sections - drag and drop to customize layout

Stretch goal: an Electron-based app version in the future.


Setup Instructions

  1. Clone this repository

    git clone https://github.com/yourusername/pash.git
  2. Host the files

    • You can simply open index.html in your browser for local use.
    • For remote hosting, upload to any web server (even basic FTP hosting works).
  3. Set up API credentials

    • Go to Google Cloud Console:
      • Create OAuth 2.0 Client ID credentials (type: Web Application)
      • Authorise JavaScript origins and redirect URIs (e.g., https://yourdomain.com/pash/).
      • Important: Redirect URIs must exactly match your deployed URL, including trailing slashes.
    • Enable the Google Calendar API and Google Tasks API.
    • (Optional) Sign up for OpenWeatherMap to get a free weather API key.
  4. Configure settings

    • Open the ⚙️ Settings panel on your dashboard.
    • Enter your Google API Client ID, Google API Key, and OpenWeatherMap API Key if desired.
    • Customise title, theme, clock format, and other options.
  5. Done!


Using as a Progressive Web App (PWA)

Pash can be installed as a standalone app on most devices and platforms:

Desktop Installation (Chrome, Edge):

  1. Visit your Pash installation in the browser
  2. Look for the install icon (⊕) in the address bar or menu
  3. Click "Install" when prompted

Mobile Installation (Android):

  1. Visit your Pash installation in Chrome
  2. Tap the menu (⋮) button
  3. Select "Add to Home screen"

iOS Installation (Safari):

  1. Visit your Pash installation in Safari
  2. Tap the Share (↑) button
  3. Select "Add to Home Screen"

Benefits of using Pash as a PWA:

  • Runs in its own window without browser UI
  • Adds a desktop/home screen icon for quick access
  • Faster loading through caching
  • Basic offline capabilities for the UI components

Screenshots


Important Notes

  • This app relies entirely on client-side execution. Your data remains on your device.
  • No personal or calendar/task data is ever sent to any third-party servers.
  • Pop-up blockers may interfere with the Google sign-in process.
  • Weather functionality is optional. If you do not configure a weather API key, the widget will not display live data.
  • Future development may include an optional Electron desktop version.

License

Pash is licensed under the Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0) license.

Summary:

  • You are free to share and adapt the code.
  • Attribution is required (credit the original author).
  • Non-commercial use only. Commercial use is strictly prohibited without explicit permission.

For full details, see the official license description.


Roadmap

  • Electron integration

Contributing

Contributions are welcome for non-commercial improvements! Submit a pull request or open an issue if you have suggestions or bugs to report.


Acknowledgements


Dashboard built for personal use and learning purposes. Use responsibly.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages