First off, thank you for considering contributing to Beatnik Controller! Any help is welcome and appreciated.
If you want to contribute with code, here is how to get the project running locally.
-
Fork and Clone the Repository:
git clone https://github.com/YOUR_USERNAME/beatnik-controller.git cd beatnik-controller -
Install Dependencies:
npm install
-
Run the Development Server:
ng serve
This will start a local development server at
http://localhost:4200. The app will automatically reload if you change any of the source files.
This application is built with Ionic and Capacitor, which means you can also compile it as a native app for Android and iOS.
To build the mobile apps, you will need to have the necessary development environments set up for Android (Android Studio) and iOS (Xcode).
-
Add the desired platform:
npx capacitor add android npx capacitor add ios
-
Build the web assets:
npm run build
-
Sync the web assets with the native project:
npx capacitor sync
-
Open the native project in its IDE:
npx capacitor open android npx capacitor open ios
From there, you can build and run the app on a device or emulator using the standard development tools for that platform.