greghesp/assistant-relay

Version 4 Rework

greghesp opened this issue · 1 comments

greghesp commented

Hey All,

Some of you might have noticed a new Version 4 branch appear.

I've started to rebuild Assistant Relay using Next.js. Whilst the overall functionality of Assistant Relay will largely remain the same due to the limitations on what is possible with the Assistant SDK, there are a few things to mention.

For Users

  1. 🟢 New UI
    The UI has been totally overhauled, and I am now using Tailwind CSS. This means it should now work across every browser, and also be responsive so you can use it across all your devices.

  2. 🟢 Password Access
    I know some of you are exposing Assistant Relay to the world with port forwarding, and some might be running it on a device without realising its exposed. To provide some peace of mind, I have now made it mandatory to require a password to access the dashboard, which brings me onto the next point

  3. 🟢 API Keys
    If you're exposing Assistant Relay to the outside world, that means you're exposing the Assistant Relay API, and if you have personal results turned on, giving people access to your Google account. None of this is a good idea, so to combat this issue, I plan on adding API keys as an option to the Assistant API. You will be able to create an API key in the dashboard, and pass this to Assistant Relay. No API when Assistant Relay expects one - no access.

  4. ⚪ Reworked Casting
    In Version 3.x I introduced casting which had some great feedback, however it didn't always work for everyone due to the way it was setup to work with CATT. With Version 4, I'll be changing how this works and will make it so that you can pass your usual CATT command lines straight to the API. This will mean it'll work out of the box with any CATT updates, and less bugs in Assistant Relay (hopefully)

  5. 🟡 Reworked Logging
    I'm working on putting in some proper logging to Assistant Relay that will be readable from the dashboard. This should help see where the problems are so we can fix bugs quicker

  6. ⚪ Version Tracking
    This one will be optional, however right now, I have no idea how many Assistant Relay users there are, nor which version they're on. With version tracking, I hope to be able to assign your Assistant Relay installation with an anonymous ID, and then log your current version remotely. This will help me keep track of my user base, however I totally understand if you don't want to enable this.

  7. ⚪ Automatic Updates
    I'm not sure how I plan on tackling this one yet, however I've never been happy with the way you've had to install updates with Assistant Relay. Copying files and folders over is just messy and not particularly elegant. With Version 4, I want to enable automatic updating so you can update to the latest version with a click of a button. If you have any suggestions on how I can achieve this, leave them below in a comment or send me a message in the Discord chat.

On top of the above, I'll be fixing any bugs or adding any requests in that I've marked down for the Version 4 Milestone, so if you find any bugs or have any more feature suggestions, now is your time to get them sent in.

Developers

If anyone has Javascript experience and wants to get involved, feel free to clone the Version 4 branch and send in some PR's. I'm online on Discord most of the time, so drop a message in the developer channel