🛠️Preparing Ubuntu

We only have a guide to install for Ubuntu only.

Installing Dependencies

sudo apt-get update | sudo apt-get upgrade

sudo apt install git | sudo apt install curl | sudo apt install -y libudev-dev

Next is to install npm. You can either install the latest version but I had issues with it, so this is the method I used. You can try both.

Installing npm

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash | command -v nvm

^ You should see a version number output from this if successful ^

nvm install v18.17.0

Info: Make sure you are in the directory you would like the repository in before running these commands. The repository is said to work best in the desktop folder, but you may choose.

Cloning Repository and Preparing NPM

git clone https://github.com/rhysmorgan134/node-CarPlay.git | cd node-CarPlay | npm install | npm i | cd examples/carplay-web-app | npm i

Cloning Repository and Preparing NPM (backup)

git clone https://github.com/ffluxxus/web-carplay.git | cd web-carplay | npm install | npm i | cd examples/carplay-web-app | npm i

Warning: You must be in the examples/carplay-web-app directory before running these commands or you will experience errors.

Now you have two options. Run as development (do not build), or build and then run. You will get better performance if you build, but if your having issues you can just run it with npm.

Run as development

npm start

Build then run

npm install -g serve | npm run build | serve -s build

< Raw Instructions >

Raw Instructions

Run and Update OS : sudo apt-get update | sudo apt-get upgrade
Install git : sudo apt install git
Install curl : sudo apt install curl
Install node USB drivers : sudo apt install -y libudev-dev
Install nvm (bypass bad node scripts) : curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
Open New Terminal and Check For Working NVM : command -v nvm
Install Patched NPM : nvm install v18.17.0
Clone node-CarPlay : git clone https://github.com/rhysmorgan134/node-CarPlay.git
Install node-CarPlay : npm install
Init node-CarPlay : npm i
Change Directories to Example : cd examples/carplay-web-app
Init node-CarPlay-Example : npm i
Start node-CarPlay-Example (start as development, bad optimization): npm start

How to build node-CarPlay (better performance, MAKE SURE YOUR IN THE EXAMPLE FOLDER THE ENTIRE TIME):
Install npm serve : npm install -g serve
Run NPM builder : npm run build
Start build at anytime : serve -s build