-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Car Application | ||
|
||
Full-Stack Application used by Users to control a SunFounder Pi-Car | ||
|
||
## Description | ||
|
||
The application contains the following: | ||
- backend: The server behind the frontend, it allows the users and car to communicate to eachother. | ||
- frontend: The frontend of the application, allows users to see the UI of the car, | ||
- raspberry-pi: The code for the raspberry pi, it allows the raspberry pi to communicate to the server and handle messages from it | ||
|
||
## Getting Started | ||
|
||
### Dependencies | ||
|
||
* [XMake](https://xmake.io/#/guide/installation) - Buildsystem for C++ | ||
* [Node.js](https://nodejs.org/en) - Used to build the frontend | ||
* [pnpm](https://pnpm.io/installation) - Used to cache the dependencies from npm | ||
|
||
### Executing program | ||
|
||
To build the backend / raspberry_pi folder, you would have to run the following command: | ||
``` | ||
xmake | ||
``` | ||
This will automatically install all the dependencies from the folder and build the executable file. | ||
|
||
## Authors | ||
|
||
[@Chi-EEE](https://github.com/Chi-EEE) | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License - see the LICENSE.md file for details | ||
|
||
## Acknowledgments | ||
|
||
[README Template](https://gist.github.com/DomPizzie/7a5ff55ffa9081f2de27c315f5018afc) |