96 lines
1.7 KiB
Markdown
96 lines
1.7 KiB
Markdown
|
# Ionic Project README
|
||
|
|
|
||
|
|
## Prerequisites
|
||
|
|
|
||
|
|
Ensure you have the following installed:
|
||
|
|
|
||
|
|
- [Node.js](https://nodejs.org/) (LTS recommended)
|
||
|
|
- [Ionic CLI](https://ionicframework.com/docs/cli) - Install via:
|
||
|
|
```sh
|
||
|
|
npm install -g @ionic/cli
|
||
|
|
```
|
||
|
|
- [Capacitor](https://capacitorjs.com/) (if using native features)
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
Clone the repository and install dependencies:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
# Clone the project
|
||
|
|
git clone <repository_url>
|
||
|
|
|
||
|
|
# Navigate to the project directory
|
||
|
|
cd <project_name>
|
||
|
|
|
||
|
|
# Install dependencies
|
||
|
|
npm install
|
||
|
|
```
|
||
|
|
|
||
|
|
## Running the App
|
||
|
|
|
||
|
|
To serve the app in a browser with live reload:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
npm run start OR ng serve
|
||
|
|
```
|
||
|
|
|
||
|
|
## Building the App
|
||
|
|
|
||
|
|
### Staging
|
||
|
|
|
||
|
|
#### Android Build
|
||
|
|
|
||
|
|
Ensure you have the Android SDK and Gradle installed. Then run:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
ionic build --configuration=staging && npx cap sync android && npx cap copy android && npx cap open android
|
||
|
|
```
|
||
|
|
|
||
|
|
### iOS Build
|
||
|
|
|
||
|
|
Ensure you have Xcode installed (macOS required). Then run:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
ionic build --configuration=staging && npx cap sync ios && npx cap copy ios && npx cap open ios
|
||
|
|
```
|
||
|
|
|
||
|
|
### Production
|
||
|
|
|
||
|
|
#### Android Build
|
||
|
|
|
||
|
|
Ensure you have the Android SDK and Gradle installed. Then run:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
ionic build --prod && npx cap sync android && npx cap copy android && npx cap open android
|
||
|
|
```
|
||
|
|
|
||
|
|
### iOS Build
|
||
|
|
|
||
|
|
Ensure you have Xcode installed (macOS required). Then run:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
ionic build --prod && npx cap sync ios && npx cap copy ios && npx cap open ios
|
||
|
|
```
|
||
|
|
|
||
|
|
## Additional Commands
|
||
|
|
|
||
|
|
To sync native changes:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
ionic capacitor sync
|
||
|
|
```
|
||
|
|
|
||
|
|
To open the native project in Android Studio or Xcode:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
ionic capacitor open android
|
||
|
|
ionic capacitor open ios
|
||
|
|
```
|
||
|
|
|
||
|
|
Ensure your Ionic CLI and Capacitor are up to date:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
npm update -g @ionic/cli
|
||
|
|
npm update @capacitor/core @capacitor/cli
|
||
|
|
```
|