hypertuner-cloud/README.md

2.6 KiB

SpeedyTuner Cloud

Netlify Status master CodeQL Maintainability Test Coverage License

Share your Speeduino tune and logs.

https://speedytuner.cloud

Screenshot

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

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

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.

Install and run

# install packages
npm install

# run development server
npm start

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