mechawrench / wificom-webapp Goto Github PK

View Code? Open in Web Editor NEW

2.0 2.0 0.0 2.61 MB

WebApp portion of the WiFiCom Project

License: MIT License

PHP 13.34% JavaScript 5.04% CSS 2.62% Blade 78.99%

digimon dmcomm rp2040 wificom legendz

wificom-webapp's Introduction

WiFiCom WebApp (Built using Laravel)

Description

This repo contains the webapp code used on the serverside for the WiFiCom project. This code is open source and free for use by anyone.

Requirements

Documentation

These docs are incomplete at this time, but enough information is given to get you started if you're familiar with Laravel.

Installation

Clone the repo
Deploy using a php stack such as wamp/lmap/xampp, you can also use Laravel Forge or Ploi.io to automatically build out the required infrastructure and security.
Run the following command to copy the .env.example file to .env:

cp .env.example .env

Run the following command to install composer dependencies:

composer install --no-dev

Run the following command to install npm dependencies:

npm install && npm run build

Generate a new App Key

php artisan key:generate

Ensure you have a database ready to go with a user and password
1. Edit the .env file and add your database credentials
Run the following command to migrate the database:

php artisan migrate --force

Run the following command to seed the database:

php artisan db:seed

- Pay attention to the output here, your initial admin user and login is provided, you'll need these later

Populate the remaining ENV variables
1. You'll need the following
  - APP_NAME=WiFiCom
  - ASSET_URL=https://yoursiteurl.com
  - APP_URL=https://yoursiteurl.com
  - an email server
  - a digitalocean spaces bucket
  - MQTT server setup
    - MQTT_AUTH_USERNAME=admin
    - MQTT_AUTH_PASSWORD=PASSWORD_FROM_EARLIER_IN_CLI_OUTPUT
  - Sentry DSN (Optional, used to track errors)
You'll need to setup a cron job for the scheduler to run every minute

* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1

You'll need to setup a daemon for the mqtt:listener to run eternally
1. Use Supervisor to start the daemon cd /path-to-your-project && php artisan mqtt:listener
Ensure you can access the site
Create an account (will require email verification)
Test out the features, report back with any issues on this Repo

wificom-webapp's People

Contributors

Stargazers

Watchers

wificom-webapp's Issues

What to do about Subscribed Applications?

It's an extra setup step that's really easy to forget.
It doesn't really add any security because the app ID isn't a secret.
Now people can create multiple API tokens, give one to each app, and revoke them if needed.

Make recent API requests visible on the site

Logging events is tricky, I can do so but the question remains should this log persist forever? Should it be stored in the database, in the cache?

Probably doesn't need to be particularly persistent, so cache would be fine then? Main use case is "something isn't working / is behaving unexpectedly, so want to check what's going on".

For apps with hidden requests it could just show the app name and the timestamp. For apps with open requests it could show more info about what the request was too.

Reordering Wifi Coms should be reflected in RTB?

"WiFiCom Status" and "WiFiCom Device to Use" still show the original order.

Stop status messages moving other elements around

In RTB there's a big space on the left of the buttons that they could go in. In Wifi Coms there isn't so much space, but it's a matter of reserving enough so that the message appearing doesn't expand it.

Create GitHub Actions deployment

I suggested that all branches could deploy to QA and we just get the most recently updated one, so that you can easily squash-merge changes when finished.

Show the commit ID on the website so we can easily find the exact corresponding source for the version we're using.

Streamline "Accept Realtime Battle" input

I proposed on Discord:

move device selection above invite code
changing device selection clears invite code

(There still needs to be an error message if user enters the same invite code again.)

Improve "Recent Output"

Clear when page is reloaded
Clear when "Send Digirom" is clicked - wait it does already? but not always for some reason?
Don't clear based on time
Add an indicator for how long ago it was?

Fix whitespace in downloaded secrets.py

Ideally the same layout as secrets.example.py

Make ack more responsive

When a digirom or RTB command is submitted, immediately put some text and/or a spinner to show that we're waiting for a response from the WiFiCom. Switch to the success message when ack is received. Stop waiting and show an error message if ack is not received within a reasonable time.

Editing the digirom or RTB command should probably remove the success/failure message, or stop waiting for ack if we were still waiting.

Rename RTB types

We agreed "Digimon 3-prong battle" and "Legendz battle".

Buttons for "Accept Realtime Battle" should be mutually exclusive

On the guest side, when we can start we can't retry, and vice versa.

Show errors in Recent Output

I believe currently it searches for "r:" to decide whether to display the output. Let's have "Error" in addition.

ReceiveError is probably being reported already. More to come in mechawrench/wificom-lib#83

Make status messages expire

As we discussed, make them disappear after a short time? Or leave them but change the appearance (e.g. grey+strikethrough).

Acknowledgement of commands

It would be good if the WiFiCom acknowledged commands and the website status messages could say something different depending on whether this happened or not. As a first step, the webapp could add a unique ID to commands? Then at some point wificom-lib can respond? Then after that the webapp could be updated to do something with the response?

Generate the 3 outputs of secrets.py from the same template?

Currently they are a little different, which seems untidy, and could cause confusion with future updates.