Commit cdedeb96 authored by mikamboo's avatar mikamboo
Browse files

Update docs : install client + server

parent 8e04ed97
# appbase-doc
App Base project documentation
Copyright Lab-241 2016.
......@@ -44,7 +44,7 @@ Server is running at `http://localhost:3000`
```
$ git clone git@git.mikangali.com:lab-241/appbase-client-ionic
$ cd appbase-client-ionic
$ bower install
$ npm install
$ ionic serve --lab
# Run ionic app on android
......@@ -57,4 +57,4 @@ $ ionic run android --livereload
* [Project website](http://appbase.ga)
* [Github repo](https://github.com/lab-241/appbase)
* [Slides show](https://slides.com/mikamboo/app-base/edit)
\ No newline at end of file
* [Slides show](https://slides.com/mikamboo/app-base/edit)
### REST api server installation
\ No newline at end of file
### Appbase : Ionic mobile client installation
Appbase __mobile client__ is a [ionic framwork](http://ionicframework.com) project built to work with the [appbase-server](https://github.com/lab-241/appbase-server) project. This mobile client consumes the [appbase-server](https://github.com/lab-241/appbase-server) REST api.
## Pre requistes
* [Node.js](http://nodejs.org), Cordova and [Ionic-cli](https://npmjs.org/package/ionic) are required on your computer to start this project.
## Dev tools install
When [Node.js](http://nodejs.org) is present on your environment just run following command to install appbase-ionic dev requirements.
```
$ npm install -g cordova ionic grunt-cli gulp bower karma-cli phantomjs
```
__CAUTION__ : Before start the client, you must ensure that server is up and running. Read [install server tutorial](../server/install.md) for instructions.
## Get + start appbase ionic
```
$ git clone git@git.mikangali.com:lab-241/appbase-client-ionic
$ cd appbase-client-ionic
$ npm install
$ ionic serve --lab
```
## Run ionic app on android device/emulator
```
$ ionic platform android
$ ionic run android --livereload
```
### About Ionic framework
Ionic is an open source mobile SDK for developing cross-platfom
![](../img/ionic-logo.png)
For more about ionic projects, read official [doc](http://ionicframework.com/getting-started/).
### REST api server installation
\ No newline at end of file
### REST api server configuration
## Appbase data store
### Mobile app installation
\ No newline at end of file
## Appbase: server installation
Appbase server is a [loopback framwork](http://loopback.io) project built to expose a REST API that appbase clients (like [ionic-client](https://github.com/lab-241/appbase-client-ionic)) will consumes.
### Pre requistes
* [Node.js](http://nodejs.org) and [loopback framwork](http://loopback.io) are required on your computer to start this project.
### Dev tools install
When [Node.js](http://nodejs.org) is present on your environment just run following command to install Loopback.
```
$ npm install -g strongloop grunt-cli
```
### Get + start appbase loopback server
```
$ git clone git@git.mikangali.com:lab-241/appbase-server
$ cd appbase-server
$ npm install
$ grunt serve
```
Server is running at : [http://localhost:3000](http://localhost:3000)
### About Loopback framework
Loopback is a opensource Node.js API framework for building REST APIs for your client applications (browser, mobile, etc).
![](../img/powered-by-LB-logo.png)
For more about Loopback projects, read official [doc](http://loopback.io/getting-started/)
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment