/up-dashboard

A simple project that provides a way to self-manage your own up dashboard.

Primary LanguagePHPMIT LicenseMIT

license php laravel production ready last commit contributors sonarqube-quality sonarqube-vulnerabilities sonarqube-security

up yeah dashboard

A simple project that provides a way to self-manage your own up dashboard.

Prerequisites

  • PHP 7.4
  • A web server with bcrypt support

Installation

Run the following commands to get everything setup.

$ composer install --prefer-dist
$ yarn
$ yarn prod

Development

The above commands will build production packages/code, if you prefer a development environment use the below instead.

$ composer install
$ yarn
$ yarn dev

Configuration

Ensure you generate a key using the below command and fill in all the relevant configurations required for your environment in the .env file.

$ php artisan key:generate

Migrations

To install the database tables run:

$ php artisan migrate

Post-installation

Upon completing the configuration and navigating to the application in your browser, you will be asked to create an initial user account. I have opted to use authentication on the off chance someone happens to use this in a production environment even though it is not production ready.

You will also need to setup an API token

Todo

  • View transactions for accounts
  • Dive into a transaction
  • Customise accounts with different labels, emoji, etc.
  • Configure webhooks
  • See the status of webhooks
  • Web notifications
  • IFTTT integration
  • User account management

The legal bit

This dashboard is not endorsed nor offered by Up. It is a personal project and is not security tested, therefore, you will be using this software at your own risk. Terms such as up and up yeah are trademarks of Up.

Copyright (c) 2020 Chris Shaw.