Skip to content

📘 A basic Vue (Vuex + Router) template with Ionic & Capacitor

Notifications You must be signed in to change notification settings

W4G1/ionic-vue-starter

Repository files navigation

📘 Ionic Vue Starter

NPM Version Node Version Ionic Version

Ionic Vue Starter is a basic Vue CLI 3 (including Vuex & Vue Router) template with Ionic 4 and Capacitor integrated.

Ionic components be used in every Vue component. Take a look here for all the available components: https://beta.ionicframework.com/docs/components/

🔧 Getting started

Requirements

  • Node (Of course) v8.12.0 <
  • NPM v6.4.1 <
  • Ionic CLI v4.5.0 < (npm install -g ionic)
  • Vue CLI v3.0.5 < (npm install -g @vue/cli)

(Optional) for Android Compiling

(Optional) for IOS Compiling

Download

Clone the repository

git clone https://github.com/W4G1/ionic-vue-starter

Or download directly as .zip

Installing dependencies

npm install

Adding a platform for development

{platform} can be 'android', 'electron', 'ios', or 'web'.

npm run init {platform}

Running the development server

This is the Vue dev server, and features hot reloading.

npm run serve

🔥 Commands

Command Description
npm run serve Starts development server with hot reloading.
npm run build {platform} Builds the project and opens the native platform workspace.
npm run init {platform} Adds a new platform to the project with its own folder (e.g /android or /ios).
npm run sync {platform} Synchronizes the web assets with a specific project folder, or all initialized platforms if {platform} is left empty.

📦 Building

Android

Requirements

Guide

Run this command to sync the web assets with the android project folder, and open the project in Android Studio.

npm run build android

Android Studio should now be started. If not, you either didn't install it, or it is installed at a custom location.

If that is the case, you can specify the Android Studio path in capacitor.config.json.

For Windows:

{
    ...
    "windowsAndroidStudioPath": "C:\\Program Files\\Android\\Android Studio\\bin\\studio64.exe",
}

Or Linux:

{
    ...
    "linuxAndroidStudioPath": "/usr/local/android-studio/bin/studio.sh"
}

The project should now be loaded in Android Studio, and is ready for building. If you don't know how to build a project in Android Studio, take a look here.

IOS

Requirements

Guide

Coming soon!

Bugs & Questions

For any bugs or questions, feel free to create an issue here.

About

📘 A basic Vue (Vuex + Router) template with Ionic & Capacitor

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published