hypertuner-cloud/README.md

SpeedyTuner Cloud

Share your Speeduino tune and logs.

https://speedytuner.cloud

Project main goals

• 🚀 always free and open source (FOSS)
• 💻 Cloud based web app with CDN
• 🔥 60 FPS animations and fast load times
• 👍 good user experience
  • 💎 intuitive, modern and responsive UI
  • 👶 easy for newcomers with tips, tools and simple diagnostics
  • 📱 touch screen friendly

ECU firmware

• Documentation: wiki.speeduino.com
• Source code: noisymime/speeduino

Contributing 🤝

There are many ways in which you can participate in the project and every bit of help is greatly appreciated.

• 👋 Say Hi and start a conversation over at Discussions
• 🐞 Submit bugs and feature requests
• 🧪 Test on different platforms, hardware and Speeduino firmware
• 👓 Review source code
• ⌨️ Write tests and refactor code according to best practices

Development

Recommended dev environment

• Node 16.x.x

Authenticate to GitHub Packages

Project uses shared packages (@speedy-tuner/...).

They are hosted using GitHub Packages, to install them you need to authenticate to GitHub Packages first.

Private token can be assing to ENV like so when running npm install in the same shell:

export NPM_GITHUB_TOKEN=YOUR_PRIVATE_GITHUB_TOKEN

Install and run

# install packages
npm install

# run development server
npm start

# open in browser
open http://localhost:3000