https://github.com/coders-school/car-dashboard
https://github.com/coders-school/car-dashboard
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/coders-school/car-dashboard
- Owner: coders-school
- Created: 2024-01-20T08:57:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-14T00:24:44.000Z (about 2 years ago)
- Last Synced: 2024-04-14T14:57:27.759Z (about 2 years ago)
- Language: QML
- Size: 36 MB
- Stars: 2
- Watchers: 5
- Forks: 1
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Car Dashboard
## Main goal
Create a modern Car Dashboar using QT framework(QT creator, QT desinger).
## How to start?
1. Download QT Framewrk.
2. Clone the repository.
3. Open QT Design.
4. Open project by clicking in project direcotry the "CarDashboard.qml" file.
## Example and division of Classes
## Development
- C++20 (recommended g++ or clang++)
- CMake 3.21.1
- Qt 6.7.0
- Qt Design Studio 4.4
- Qt Creator 13.0
- clang-format
- clang-tidy
- cppcheck
- ninja
- valgrind
### Clone repository
- clone repository: `https://github.com/coders-school/car-dashboard`
### Qt
You can open project with:
- Qt Design Studio
- Run Qt Design Studio and open CarDashboard.qmlproject file.
- User settings are saved in CarDashboard.qmlproject.qtds.
- Qt Creator
- Run Qt Creator and open CMakeLists.txt file.
- User settings are saved in CMakeLists.txt.user.
#### Generate CMake
If you added files in Qt Design Studio (.qml, .png, .svg, ...), you must generete CMake by run executable file.
Open Qt Design. Then File > Export > Generate CMake. In details select CMakes which you want generate and click ok.
`Warning: Please commit before generate`
### Run from terminal
#### 1. Run cmake
- For Unix
```
cmake -S -B -DCMAKE_PREFIX_PATH=[QT DIR]/[QT VERSION]/gcc_64 ...
```
- For Windows
```
cmake -S -B -DCMAKE_PREFIX_PATH=[QT DIR]/[QT VERSION]/mingw ...
```
Example:
```
cmake -S . -B build -DCMAKE_PREFIX_PATH=/home/user/Qt/6.7.0/gcc_64 -G Ninja
```
Or
```
mkdir build
cd build
cmake .. -DCMAKE_PREFIX_PATH=/home/user/Qt/6.7.0/gcc_64
```
#### 2. Build
```
cmake --build
```
For ninja:
```
ninja -C
```
Examples:
```
cmake --build build
ninja -C build
```
#### 3. Run
```
.//CarDashboardApp
```
#### 4. Unit tests
````
ctest --test-dir
````
For ninja:
```
ninja -C test
```
Or run executable file directly:
```
./build/utest/CarDashboardApp_UnitTest
./build/utestQml/CarDashboardApp_UnitTestQml
```
### Code analysis
#### CMake targets
CMake provided following targets for code analysis:
- `clang-format` - formating code
- `clang-format-check` - check formating without chagned code
- `cppcheck-check` - run cppcheck
- `clang-tidy-check` - run clang-tidy without chagned code
- `clang-tidy-fix` - run clang-tidy and fix code
Run cmake target:
```
cmake --build --target
```
For ninja
```
ninja -C build
```
#### clang-format
CMake targets:
- clang-format
- clang-format-check
#### cppcheck
CMake targets:
- cppcheck-check
#### clang-tidy
CMake targets:
- clang-tidy-check
- clang-tidy-fix
#### pre-commit
In the project is added `pre-commit`, which is run before commit.
If an error occurred, try: `pip install --force-reinstall -U pre-commit`
##### Set up:
```
pre-commit install
```
#### valgrind
```
valgrind --leak-check=full \
--show-leak-kinds=all \
--track-origins=yes \
--verbose \
.//CarDashboardApp
```
## Description
### $${\color{red}1.Class \space Car \space Gauges}$$
- Speed Gauge
- RPM Gauge
- Additional: timer, thermometer etc.
### $${\color{blue}2.Class \space 3D \space Car}$$
- 3D car model that can be moved by mouse
- Open doors and trunk by using buttons on screen
### $${\color{yellow}3.Class \space A/C \space Sit \space Control}$$
- Change the temperature by using A/C button
- Change the postion of sit by using sit control button
### $${\color{green}4.Class \space Phone \space Calling}$$
- Choose number to call
- Adding new phone numbers to phone book
### $${\color{purple}5.Class \space Music \space Player}$$
- Change music
- Change beetwen radio and songs
- Mute, volume etc.
### $${\color{grey}6.Class \space Navigation}$$
- Navigation map
- Search tool bar
### $${\color{brown}7.Class \space Menu}$$
- Switching menu beetwen classes (apart from Gauges)
- Seperate Right from the Left side of the screen