Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
Chi-EEE committed Dec 6, 2023
1 parent af364e4 commit 6f3f73d
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
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)

0 comments on commit 6f3f73d

Please sign in to comment.