Merge pull request #68 from tvories/feat/dev_docs
Clarified Android and iOS setup, added more docs
79
readme.md
|
@ -15,7 +15,9 @@ Get the Android app on the [Google Play Store](https://play.google.com/store/app
|
|||
|
||||
## Contributing
|
||||
|
||||
### Windows Environment Setup
|
||||
This application is built using [NuxtJS](https://nuxtjs.org/) and [Capacitor](https://capacitorjs.com/) in order to run on both iOS and Android on the same code base.
|
||||
|
||||
### Windows Environment Setup for Android
|
||||
|
||||
Required Software:
|
||||
|
||||
|
@ -46,7 +48,7 @@ winget install -e --id OpenJS.NodeJS --version 16.12.0; #v17 has issues with ope
|
|||
|
||||
Your Windows environment should now be set up and ready to proceed!
|
||||
|
||||
### Mac Environment Setup
|
||||
### Mac Environment Setup for Android
|
||||
|
||||
Required Software:
|
||||
|
||||
|
@ -67,9 +69,9 @@ brew install android-studio node cocoapods
|
|||
</p>
|
||||
</details>
|
||||
|
||||
### Start working on the project
|
||||
### Start working on the Android app
|
||||
|
||||
Clone or fork the project from cmd or powershell and `cd` into the project directory.
|
||||
Clone or fork the project from terminal or powershell and `cd` into the project directory.
|
||||
|
||||
Install the required node packages:
|
||||
```shell
|
||||
|
@ -79,7 +81,7 @@ npm install
|
|||
<details>
|
||||
<summary>Expand for screenshot</summary>
|
||||
|
||||

|
||||

|
||||
</details>
|
||||
<br>
|
||||
|
||||
|
@ -91,7 +93,7 @@ npm run generate
|
|||
<details>
|
||||
<summary>Expand for screenshot</summary>
|
||||
|
||||

|
||||

|
||||
</details>
|
||||
<br>
|
||||
|
||||
|
@ -103,7 +105,7 @@ npx cap sync
|
|||
<details>
|
||||
<summary>Expand for screenshot</summary>
|
||||
|
||||

|
||||

|
||||
</details>
|
||||
<br>
|
||||
|
||||
|
@ -121,3 +123,66 @@ npx cap open android
|
|||
<br>
|
||||
|
||||
Start coding!
|
||||
|
||||
### Mac Environment Setup for iOS
|
||||
|
||||
Required Software:
|
||||
|
||||
* [Xcode](https://developer.apple.com/xcode/)
|
||||
* [Node.js](https://nodejs.org/en/)
|
||||
* [Cocoapods](https://guides.cocoapods.org/using/getting-started.html#installation)
|
||||
|
||||
### Start working on the iOS app
|
||||
|
||||
Clone or fork the project in the terminal and `cd` into the project directory.
|
||||
|
||||
Install the required node packages:
|
||||
```shell
|
||||
npm install
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>Expand for screenshot</summary>
|
||||
|
||||

|
||||
</details>
|
||||
<br>
|
||||
|
||||
Generate static web app:
|
||||
```shell
|
||||
npm run generate
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>Expand for screenshot</summary>
|
||||
|
||||

|
||||
</details>
|
||||
<br>
|
||||
|
||||
Copy web app into native android/ios folders:
|
||||
```shell
|
||||
npx cap sync
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>Expand for screenshot</summary>
|
||||
|
||||

|
||||
</details>
|
||||
<br>
|
||||
|
||||
Open Xcode:
|
||||
|
||||
```shell
|
||||
npx cap open ios
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>Expand for screenshot</summary>
|
||||
|
||||

|
||||
</details>
|
||||
<br>
|
||||
|
||||
Start coding!
|
||||
|
|
Before Width: | Height: | Size: 136 KiB After Width: | Height: | Size: 136 KiB |
Before Width: | Height: | Size: 88 KiB After Width: | Height: | Size: 88 KiB |
Before Width: | Height: | Size: 100 KiB After Width: | Height: | Size: 100 KiB |
BIN
screenshots/dev_setup_ios_cap_open.png
Normal file
After Width: | Height: | Size: 892 KiB |
BIN
screenshots/dev_setup_ios_cap_sync.png
Normal file
After Width: | Height: | Size: 599 KiB |
BIN
screenshots/dev_setup_ios_npm_generate.png
Normal file
After Width: | Height: | Size: 544 KiB |
BIN
screenshots/dev_setup_ios_npm_install.png
Normal file
After Width: | Height: | Size: 394 KiB |