You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A generic app that can be easily configured to help the user track and optimize any given outcome variable.
3
+
A app for collecting, aggregating, and analyzing health data to identify the most effective ways to optimize your health and happiness.
4
4
5
-
[](https://gitpod-referer.now.sh/api/gitpod-referer-redirect)
5
+
# [DEMO](https://web.quantimo.do)
6
6
7
-
# DEMOS
8
-
-[QuantiModo Web App](https://app.quantimo.do)
9
-
-[QuantiModo for iOS](https://itunes.apple.com/us/app/quantimodo-life-tracker/id1115037060?mt=8)
-[QuantiModo for Android](https://play.google.com/store/apps/details?id=com.quantimodo.quantimodo)
7
+
# Quick Start
8
+
[](https://gitpod-referer.now.sh/api/gitpod-referer-redirect)
12
9
13
-
#5-Minute Quick Start
10
+
### Local Development
14
11
1. Fork this repository.
15
12
1. Install [Node.js](http://nodejs.org/). (Windows Developers: We recommend [Visual Studio Community](https://taco.visualstudio.com/), which automatically installs everything you need!)
16
13
1. Install the latest Cordova and Ionic command-line tools in your terminal with `npm install -g gulp [email protected][email protected] bower cordova-hot-code-push-cli`. # Adding plugins from Github doesn't work on [email protected]
17
14
(Mac Users: Avoid using `sudo` with your npm commands if possible as it tends to cause problems.)
18
15
1. Run `npm install` in the root of this repository.
19
-
1. Create your application at [app.quantimo.do/api/v2/apps](https://app.quantimo.do/api/v2/apps).
16
+
1. Create your application at [app.quantimo.do/api/v2/apps](https://builder.quantimo.do).
20
17
1. Run `gulp devSetup` in the root of this repository, follow the prompts, and you should see your app at
21
18
[http://localhost:8100/#/](http://localhost:8100/#/) or similar.
22
19
1. Need help? Please [create an issue](https://github.com/QuantiModo/quantimodo-android-chrome-ios-web-app/issues) or contact us at [help.quantimo.do](http://help.quantimo.do).
23
20
24
21
## QuantiModo API
25
22
For more info about the types of data you can store and get from the QuantiModo API, try out our
26
-
[Interactive API Explorer](https://app.quantimo.do/api/v2/account/api-explorer)
23
+
[Interactive API Explorer](https://docs.quantimo.do)
27
24
28
-
## [Complete Documentation](docs)
29
-
30
-
## [Contribute](docs/contributing.md)
31
25
32
26
## Screenshots
33
27
<palign="center">
@@ -40,197 +34,11 @@ For more info about the types of data you can store and get from the QuantiModo
Ionic docker image for development, build and continous integration (and certainly useful for all Cordova projects in general as well)
46
-
47
-
48
-
## Why
49
-
- Installing Java and Android SDK is a pain
50
-
- Keeping your Node modules in sync and up-to-date is a pain
51
-
- Ensuring all project developers have exactly the same Java version, Android SDK, and node modules is a Sisyphos like task, not to mention your CI environment.
52
-
- Using a standardized Docker image and a versionednDocker-Compose file for your project ensures an identical environment for all developers, testers, build bots etc.
53
-
54
-
55
-
## Features
56
-
- Based on Ubuntu 16.04
57
-
- Minimal assumptions/restrictions regarding your development environment and project structure
Build the docker image (grab a coffee, this might take a while when you run it the first time)
92
-
```
93
-
docker-compose build
94
-
```
95
-
*This will only work, if you have docker already installed on your machine. If not, please look at the Usage section for more instructions.*
96
-
97
-
Start the development server
98
-
```
99
-
docker-compose up
100
-
```
101
-
Congratulations! Look at the default Ionic project at localhost:8100 that is served out of your Docker container.
102
-
103
-
**If you want to know, how to get your own Ionic project served and built out of the Docker container, follow the instructions below.**
104
-
105
-
106
-
## Usage
107
-
1. Install Docker
108
-
Install docker for your platform [Linux](https://docs.docker.com/engine/installation/linux/ubuntu/), [Mac](https://docs.docker.com/docker-for-mac/install/) or [Windows](https://docs.docker.com/docker-for-windows/install/).
109
-
110
-
111
-
2. Build your image and start your container
112
-
You can build your image and start your container directly with docker. Or you can use docker-compose. In general, we recommend to download our compose file and work with docker-compose.
113
-
114
-
3. How to develop your local Ionic project in the Docker container
115
-
The provided image / container does have an Ionic app setup and installled in the directory /app. This app is only for demo purposes and not intended for development. You you should create / integrate your Ionic project from the host aka your development machine. Therefore, you map your local Ionic project directory to the container via a volume mapping. This will work out of the box if you follow instructions below.
116
-
117
-
By default, the Docker container has a start script that watches your package.json, which installs on start or on changes.
118
-
119
-
120
-
## Usage with docker-compose
121
-
122
-
To manage the build and run options in your project via cli parameters is a hassle and does not scale very well in larger project teams. Therefore, we recommend to use a compose file, which can be versioned and should be checked into your project repository.
123
-
124
-
1. Create your inital docker-compose.yml file
125
37
126
-
Download it from our repository into your project root
and customize it to your needs. However, the defaults should be good to start with.
131
-
132
-
2. Build your image
133
-
134
-
After customizing your docker-compose file, build your project specific image
135
-
```
136
-
docker-compose build
137
-
```
138
-
139
-
3. Run the container
140
-
141
-
The default container command is "ionic serve -b". Thus, by just starting the container via
142
-
```
143
-
docker-compose up
144
-
```
145
-
you will have your development server up and running on port 8100.
146
-
147
-
You can change the default command by appending to cli call. E.g. this command
148
-
```
149
-
docker-compose run ionic npm run test
150
-
```
151
-
will start the unit tests.
152
-
153
-
4. Run specific one-off commands
154
-
Use the run commaned for one-off commands. E.g. to build the Android APKs just run
155
-
```
156
-
docker-compose run ionic ionic build android
157
-
```
158
-
159
-
If you want to check the build configuration of your underlying container, just run
160
-
```
161
-
docker-compose run ionic cat /image.config
162
-
```
163
-
164
-
165
-
## Usage with docker
166
-
167
-
1. Build your custom docker image
168
-
169
-
```
170
-
docker build -tag [IMAGE_NAME] \
171
-
--build-arg [ARG=VALUE] \
172
-
https://github.com/mswag/docker-ionic
173
-
```
174
-
(this might take a while the first time)
175
-
176
-
Please choose an appropriate IMAGE_NAME for the built image; the name of your project might be a good idea.
177
-
178
-
The following build arguments can be used to customize your image:
179
-
- USER (mandatory, default: ionic): the project user, which will be used to run this Docker container
180
-
- JAVA_VERSION (mandatory, default: 8): the java version that should be installed and used to run the Android SDKstalled and used by Cordova
181
-
- ANDROID_PLATFORMS_VERSION (mandatory, default: 25): the Android SDK Tools platforms version that should be installed and used by Cordova
182
-
- ANDROID_BUILD_TOOLS_VERSION (mandatory, default: 25.0.3): the Android build tools version that should be installed and used by Cordova
183
-
- NODE_VERSION (mandatory, default: 6.9.1): the node version that should be installed globally and used by Cordova and Ionic
184
-
- NPM_VERSION (mandatory, default: 5.3.0): the npm version that will be installed with node globally
185
-
- PACKAGE_MANAGER (mandatory, default: npm): if yarn or npm should be used as package manager
186
-
- CORDOVA_VERSION (mandatory, default: 6.5.0): the Cordova version that will be installed globally and used by Ionic to build the Android APKs
187
-
- IONIC_VERSION (optional, default: 2.2.1): the Ionic version that will be installed globally to power your project
188
-
- TYPESCRIPT_VERSION (optional, default: 2.0.3): the Typescript version that will be installed globally to translate your .ts files
189
-
- GULP_VERSION (optional, default: none): the Gulp version that will be installed globally to run your gulp tasks
190
-
191
-
*Example for Ionic 2 project*:
192
-
```
193
-
docker build --tag my-great-ionic2-project \
194
-
--build-arg USER="$USER"
195
-
https://github.com/mswag/docker-ionic
196
-
```
197
-
This will generate a Docker image named "my-great-ionic2-project" with the default configuration and a user, who's name is identical to the one on the host.
198
-
199
-
200
-
2. Feel free to use your image and connect with a bash shell:
This will run the created image with the following features:
211
-
212
-
- **Project Directory**:
213
-
214
-
The option ```-v $PWD:/app:rw``` will map your hosts current directory to /app in the container. This should allways be our project root directory, where the package.jsons ist provided.
215
-
216
-
- **USB Devices**:
217
-
218
-
The option ```-v /dev/bus/usb:/dev/bus/usb``` will map your hosts usb ports such that you can build/deploy your project directly to your device.
219
-
220
-
**Attention**: this will not work on osx.
221
-
222
-
- **Container User Id**
223
-
224
-
The option ```-u `id -u $USER``` will run the container with the current user's id. This will avoid permissions issues on the host.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments