29 |
30 |
31 |
39 |
40 |
41 |
57 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # :blue_book: Ionic Vue Starter
2 | [](https://nodejs.org/) [](https://nodejs.org/) [](https://beta.ionicframework.com/)
3 |
4 | Ionic Vue Starter is a basic Vue CLI 3 (including Vuex & Vue Router) template with Ionic 4 and Capacitor integrated.
5 |
6 | Ionic components be used in every Vue component. Take a look here for all the available components: https://beta.ionicframework.com/docs/components/
7 |
8 | ## :wrench: Getting started
9 | ### Requirements
10 | - [Node](https://nodejs.org/) (Of course) v8.12.0 <
11 | - [NPM](https://www.npmjs.com/) v6.4.1 <
12 | - Ionic CLI v4.5.0 <
13 | (`npm install -g ionic`)
14 | - Vue CLI v3.0.5 <
15 | (`npm install -g @vue/cli`)
16 | #### (Optional) for Android Compiling
17 | - [Android Studio](https://developer.android.com/studio/)
18 | #### (Optional) for IOS Compiling
19 | - [Xcode](https://developer.apple.com/xcode/) (OS X only)
20 |
21 | ### Download
22 | Clone the repository
23 | ```sh
24 | git clone https://github.com/W4G1/ionic-vue-starter
25 | ```
26 | Or [download](https://github.com/W4G1/ionic-vue-starter/archive/master.zip) directly as .zip
27 |
28 | ### Installing dependencies
29 | ```sh
30 | npm install
31 | ```
32 |
33 | ### Adding a platform for development
34 | {platform} can be 'android', 'electron', 'ios', or 'web'.
35 | ```sh
36 | npm run init {platform}
37 | ```
38 |
39 | ### Running the development server
40 | This is the Vue dev server, and features hot reloading.
41 | ```sh
42 | npm run serve
43 | ```
44 |
45 | ## :fire: Commands
46 | | Command | Description |
47 | | ------ | ------ |
48 | | `npm run serve` | Starts development server with hot reloading. |
49 | | `npm run build {platform}` | Builds the project and opens the native platform workspace. |
50 | | `npm run init {platform}` | Adds a new platform to the project with its own folder (e.g /android or /ios). |
51 | | `npm run sync {platform}` | Synchronizes the web assets with a specific project folder, or all initialized platforms if {platform} is left empty. |
52 |
53 | ## :package: Building
54 | ### Android
55 | #### Requirements
56 | - [Android Studio](https://developer.android.com/studio/).
57 | #### Guide
58 | Run this command to sync the web assets with the android project folder, and open the project in Android Studio.
59 | ```sh
60 | npm run build android
61 | ```
62 | Android Studio should now be started. If not, you either didn't install it, or it is installed at a custom location.
63 |
64 | If that is the case, you can specify the Android Studio path in `capacitor.config.json`.
65 |
66 | For Windows:
67 | ```json
68 | {
69 | ...
70 | "windowsAndroidStudioPath": "C:\\Program Files\\Android\\Android Studio\\bin\\studio64.exe",
71 | }
72 | ```
73 | Or Linux:
74 | ```json
75 | {
76 | ...
77 | "linuxAndroidStudioPath": "/usr/local/android-studio/bin/studio.sh"
78 | }
79 | ```
80 |
81 | 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](https://developer.android.com/studio/run/).
82 |
83 | ### IOS
84 | #### Requirements
85 | - [Xcode](https://developer.apple.com/xcode/) (OS X only).
86 | #### Guide
87 | Coming soon!
88 |
89 | ## Bugs & Questions
90 | For any bugs or questions, feel free to create an issue [here](https://github.com/W4G1/ionic-vue-starter/issues).
91 |
--------------------------------------------------------------------------------