Initial commit

This commit is contained in:
karniv00l 2021-08-15 13:46:58 +02:00
commit 6c1e470e0c
No known key found for this signature in database
GPG Key ID: F40F61D5587F5673
6 changed files with 110 additions and 0 deletions

10
.editorconfig Normal file
View File

@ -0,0 +1,10 @@
# top-most EditorConfig file
root = true
# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true
charset = utf-8
indent_style = space
indent_size = 2

1
.env Normal file
View File

@ -0,0 +1 @@
BROWSER=none

29
.gitignore vendored Normal file
View File

@ -0,0 +1,29 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
# dependencies
node_modules
.pnp
.pnp.js
# testing
/coverage
# production build
/build
/out
# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.eslintcache
# custom ts builds
/src/**/*.js

10
.vscode/extensions.json vendored Normal file
View File

@ -0,0 +1,10 @@
{
// See http://go.microsoft.com/fwlink/?LinkId=827846
// for the documentation about the extensions.json format
"recommendations": [
"editorconfig.editorconfig",
"dbaeumer.vscode-eslint",
"sonarsource.sonarlint-vscode",
"davidanson.vscode-markdownlint"
]
}

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2021 Piotr Rogowski
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

39
README.md Normal file
View File

@ -0,0 +1,39 @@
# SpeedyTuner
Slick and modern way to tune your [Speeduino ECU](https://speeduino.com/).
## Project main goals
- 🚀 always free and open source (FOSS)
- 💻 cross-platform desktop app (Linux, MacOS, Windows)
- 🔥 `60Hz` logging and `60 FPS` animations
- 🏎 fast startup and low resource consumption
- 👏 fully featured
- 🚗 all tuning essentials and beyond
- 👍 good user experience
- 💎 intuitive, modern and responsive UI
- 👶 easy for newcomers with tips, tools and simple diagnostics
- 📱 touch screen friendly
Written in [TypeScript](https://github.com/microsoft/TypeScript) using [React](https://github.com/facebook/react) and [Electron](https://github.com/electron/electron).
## 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/speedy-tuner/speedy-tuner-cloud/discussions)
- 🐞 [Submit bugs and feature requests](https://github.com/speedy-tuner/speedy-tuner-cloud/issues)
- 🧪 Test on different platforms, hardware and Speeduino firmware
- 👓 Review source code
- ⌨️ Write tests and refactor code according to best practices
### Development
*Not yet started.*
Please see [speedy-tuner-cloud](https://github.com/speedy-tuner/speedy-tuner-cloud).