2021-03-22 14:29:03 -07:00
# SpeedyTuner Cloud
2021-09-26 09:11:55 -07:00
[](https://app.netlify.com/sites/speedytuner/deploys)
2021-11-27 02:19:32 -08:00
[](https://github.com/speedy-tuner/speedy-tuner-cloud/actions/workflows/codeql-analysis.yml)
2021-08-20 01:41:02 -07:00
[](https://codeclimate.com/github/speedy-tuner/speedy-tuner-cloud/maintainability)
2021-08-20 01:47:08 -07:00
2021-11-27 02:32:20 -08:00
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fspeedy-tuner%2Fspeedy-tuner-cloud?ref=badge_shield)
2021-03-23 09:23:33 -07:00
2021-08-15 04:57:37 -07:00
Share your [Speeduino ](https://speeduino.com/ ) tune and logs.
2021-03-22 14:29:03 -07:00
2021-03-22 15:12:53 -07:00
## [https://speedytuner.cloud](https://speedytuner.cloud)
2021-03-23 02:10:21 -07:00
2021-08-15 04:57:37 -07:00
## 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 ](https://wiki.speeduino.com/ )
- Source code: [noisymime/speeduino ](https://github.com/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 ](https://github.com/karniv00l/speedy-tuner/discussions )
- 🐞 [Submit bugs and feature requests ](https://github.com/karniv00l/speedy-tuner/issues )
- 🧪 Test on different platforms, hardware and Speeduino firmware
- 👓 Review source code
- ⌨️ Write tests and refactor code according to best practices
2021-03-22 14:29:03 -07:00
## Development
2021-09-26 09:07:54 -07:00
### Recommended dev environment
2021-03-22 14:29:03 -07:00
2021-09-26 03:47:07 -07:00
- [Node ](https://nodejs.org/ ) 16.x.x
2021-03-22 14:29:03 -07:00
2021-09-26 09:07:54 -07:00
### 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 ](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-to-github-packages ) first.
2021-12-13 13:53:59 -08:00
Private token can be assing to ENV like so when running `npm install` in the same shell:
```bash
export NPM_GITHUB_TOKEN=YOUR_PRIVATE_GITHUB_TOKEN
```
2021-09-26 09:07:54 -07:00
### Install and run
2021-03-22 14:29:03 -07:00
```bash
# install packages
npm install
# run development server
npm start
# open in browser
open http://localhost:3000
```
