This repository has been archived on 2023-11-19. You can view files and clone it, but cannot push or open issues or pull requests.
goober-ionic/README.md

75 lines
1.8 KiB
Markdown
Raw Normal View History

2017-06-06 15:23:30 +00:00
# Goober, a mobile app for pnut.io
2018-07-16 02:24:48 +00:00
Copyright 2017 - 2018 Morgan McMillian
2017-06-06 15:23:30 +00:00
Goober is a cross platform mobile client for pnut.io built using the Ionic framework (http://ionicframework.com/).
## LICENSE
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
## Core build dependencies
2017-06-06 15:26:23 +00:00
2017-06-06 15:23:30 +00:00
* Install Node.js (https://nodejs.org)
* Install the latest Ionic and Cordova tools
2017-06-10 13:55:32 +00:00
```bash
npm install -g ionic cordova
```
2017-06-06 15:23:30 +00:00
## Platform build dependencies
2017-06-06 15:26:23 +00:00
#### Android
* Install Java Development Kit
* https://java.com
2017-06-06 15:23:30 +00:00
* Install either Android Studio or the command line tools
* https://developer.android.com/studio/index.html#downloads
* Install Gradle (needed if you only installed the command line tools)
* https://gradle.org/
2017-06-06 15:23:30 +00:00
## Other build dependencies
2017-06-06 15:26:23 +00:00
2017-06-06 15:23:30 +00:00
Install required node modules
2017-06-06 23:42:08 +00:00
```bash
2017-06-06 15:23:30 +00:00
cd Goober
npm install
```
Install at least one target platform
```bash
ionic cordova platform add android
```
2018-07-16 02:24:48 +00:00
## Build and run using ionic framework
2017-06-06 15:23:30 +00:00
2018-09-03 00:54:10 +00:00
Copy src/providers/pnut-oauth.ts.sample to src/providers/pnut-oauth.ts and include the client ID provided by pnut.io. See the [developer documentation](https://pnut.io/docs/api/implementation/overview) for more details.
2017-06-06 15:26:23 +00:00
#### Browser
2017-06-06 23:42:08 +00:00
```bash
2017-06-06 15:23:30 +00:00
ionic serve --lab
```
2017-06-06 15:26:23 +00:00
#### Android
2017-06-06 23:42:08 +00:00
```bash
ionic cordova platform add android
2017-06-06 15:23:30 +00:00
ionic cordova build android
ionic cordova run android
```