Commit c22d938f authored by mikamboo's avatar mikamboo
Browse files

Update docs : install missiing CNAME file

parent 269eaf28
doc.appbase.ga
Copyright (c) 2016 Lab-241
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
No preview for this file type
......@@ -199,7 +199,7 @@ $ grunt
</ul>
<pre><code>$ 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
......
......@@ -126,14 +126,36 @@
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#mobile-app-configuration">mobile App configuration</a></li>
<li class="main active"><a href="#ionic-mobile-app-configuration">Ionic mobile app configuration</a></li>
<li class="main "><a href="#setup-api-endpoint">Setup api endpoint</a></li>
<li><a href="#manually">Manually</a></li>
<li><a href="#using-grunt">Using grunt</a></li>
<li><a href="#example">Example</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h3 id="mobile-app-configuration">mobile App configuration</h3></div>
<h2 id="ionic-mobile-app-configuration">Ionic mobile app configuration</h2>
<p>In this section we wille lear how to setup appbase ionic conf.
The main config file is located at <code>www/app/conf/ConfParams.js</code>.</p>
<h2 id="setup-api-endpoint">Setup api endpoint</h2>
<p>That config make the link between the mobile app and the REST api.</p>
<h3 id="manually">Manually</h3>
<p>Edit <code>www/app/conf/ConfParams.js</code> and change the value of <code>API_ENDPOINT</code> constant.</p>
<h3 id="using-grunt">Using grunt</h3>
<p>The default grunt task can be used to edit <code>ConfParams.js</code> via env vars.
It use <a href="https://github.com/werk85/grunt-ng-constant">ngconstant</a> grunt plugin to edit de conf file.</p>
<h3 id="example">Example</h3>
<pre><code>export API_ENDPOINT=http://your-server-with-appbase.org/api
grunt &amp;&amp; ionic serve --lab
</code></pre></div>
</div>
<footer class="col-md-12">
......
......@@ -126,14 +126,55 @@
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#rest-api-server-installation">REST api server installation</a></li>
<li class="main active"><a href="#appbase-ionic-mobile-client-installation">Appbase : Ionic mobile client installation</a></li>
<li class="main "><a href="#pre-requistes">Pre requistes</a></li>
<li class="main "><a href="#dev-tools-install">Dev tools install</a></li>
<li class="main "><a href="#get-start-appbase-ionic">Get + start appbase ionic</a></li>
<li class="main "><a href="#run-ionic-app-on-android-deviceemulator">Run ionic app on android device/emulator</a></li>
<li><a href="#about-ionic-framework">About Ionic framework</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h3 id="rest-api-server-installation">REST api server installation</h3></div>
<h3 id="appbase-ionic-mobile-client-installation">Appbase : Ionic mobile client installation</h3>
<p>Appbase <strong>mobile client</strong> is a <a href="http://ionicframework.com">ionic framwork</a> project built to work with the <a href="https://github.com/lab-241/appbase-server">appbase-server</a> project. This mobile client consumes the <a href="https://github.com/lab-241/appbase-server">appbase-server</a> REST api.</p>
<h2 id="pre-requistes">Pre requistes</h2>
<ul>
<li><a href="http://nodejs.org">Node.js</a>, Cordova and <a href="https://npmjs.org/package/ionic">Ionic-cli</a> are required on your computer to start this project.</li>
</ul>
<h2 id="dev-tools-install">Dev tools install</h2>
<p>When <a href="http://nodejs.org">Node.js</a> is present on your environment just run following command to install appbase-ionic dev requirements.</p>
<pre><code>$ npm install -g cordova ionic grunt-cli gulp bower karma-cli phantomjs
</code></pre>
<p><strong>CAUTION</strong> : Before start the client, you must ensure that server is up and running. Read <a href="../../server/install/">install server tutorial</a> for instructions.</p>
<h2 id="get-start-appbase-ionic">Get + start appbase ionic</h2>
<pre><code>$ git clone git@git.mikangali.com:lab-241/appbase-client-ionic
$ cd appbase-client-ionic
$ npm install
$ ionic serve --lab
</code></pre>
<h2 id="run-ionic-app-on-android-deviceemulator">Run ionic app on android device/emulator</h2>
<pre><code>$ ionic platform android
$ ionic run android --livereload
</code></pre>
<h3 id="about-ionic-framework">About Ionic framework</h3>
<p>Ionic is an open source mobile SDK for developing cross-platfom</p>
<p><img alt="" src="../../img/ionic-logo.png" /></p>
<p>For more about ionic projects, read official <a href="http://ionicframework.com/getting-started/">doc</a>.</p></div>
</div>
<footer class="col-md-12">
......
......@@ -2,7 +2,7 @@
"docs": [
{
"location": "/",
"text": "Getting started with App Base\n\n\nApp Base is your production ready mobile app foundation.\nIts the result of two framworks combined to create a powerfull fullsatck js ecosystem.\n\n\nApp Base projects\n\n\n\n\n\n\n\n\nNeed\n\n\nSolution\n\n\nAppBase repo\n\n\n\n\n\n\n\n\n\n\nREST API\n\n\nLoopBack Framework\n\n\nAppbase server\n\n\n\n\n\n\nMobile App\n\n\nIonic Framework\n\n\nAppbase ionic\n\n\n\n\n\n\nAdmin Dashboard\n\n\nNG-admin\n\n\nAppbase server\n\n\n\n\n\n\n\n\nDevelopment quick start\n\n\nPrerequites\n\n\n\n\nNodeJs\n\n\n\n\nInstall dev tools\n\n\nApp base is built on top of ionic (who use cordova) and strongloop.\nSome others automation tools (like gulp) are required.\n\n\nnpm install -g cordova ionic strongloop grunt-cli gulp bower karma-cli phantomjs\n\n\n\n\nStart app components\n\n\n\n\nStart loopback REST api server\n\n\n\n\n$ git clone git@git.mikangali.com:lab-241/appbase-server\n$ cd appbase-server\n$ npm install\n$ grunt\n\n\n\n\nServer is running at \nhttp://localhost:3000\n\n\n\n\nStart ionic mobile app\n\n\n\n\n$ git clone git@git.mikangali.com:lab-241/appbase-client-ionic\n$ cd appbase-client-ionic\n$ bower install\n$ ionic serve --lab\n\n# Run ionic app on android\n\n$ ionic platform android\n$ ionic run android --livereload\n\n\n\n\nLinks\n\n\n\n\nProject website\n\n\nGithub repo\n\n\nSlides show",
"text": "Getting started with App Base\n\n\nApp Base is your production ready mobile app foundation.\nIts the result of two framworks combined to create a powerfull fullsatck js ecosystem.\n\n\nApp Base projects\n\n\n\n\n\n\n\n\nNeed\n\n\nSolution\n\n\nAppBase repo\n\n\n\n\n\n\n\n\n\n\nREST API\n\n\nLoopBack Framework\n\n\nAppbase server\n\n\n\n\n\n\nMobile App\n\n\nIonic Framework\n\n\nAppbase ionic\n\n\n\n\n\n\nAdmin Dashboard\n\n\nNG-admin\n\n\nAppbase server\n\n\n\n\n\n\n\n\nDevelopment quick start\n\n\nPrerequites\n\n\n\n\nNodeJs\n\n\n\n\nInstall dev tools\n\n\nApp base is built on top of ionic (who use cordova) and strongloop.\nSome others automation tools (like gulp) are required.\n\n\nnpm install -g cordova ionic strongloop grunt-cli gulp bower karma-cli phantomjs\n\n\n\n\nStart app components\n\n\n\n\nStart loopback REST api server\n\n\n\n\n$ git clone git@git.mikangali.com:lab-241/appbase-server\n$ cd appbase-server\n$ npm install\n$ grunt\n\n\n\n\nServer is running at \nhttp://localhost:3000\n\n\n\n\nStart ionic mobile app\n\n\n\n\n$ git clone git@git.mikangali.com:lab-241/appbase-client-ionic\n$ cd appbase-client-ionic\n$ npm install\n$ ionic serve --lab\n\n# Run ionic app on android\n\n$ ionic platform android\n$ ionic run android --livereload\n\n\n\n\nLinks\n\n\n\n\nProject website\n\n\nGithub repo\n\n\nSlides show",
"title": "Getting Started"
},
{
......@@ -17,7 +17,7 @@
},
{
"location": "/#development-quick-start",
"text": "Prerequites NodeJs Install dev tools App base is built on top of ionic (who use cordova) and strongloop.\nSome others automation tools (like gulp) are required. npm install -g cordova ionic strongloop grunt-cli gulp bower karma-cli phantomjs Start app components Start loopback REST api server $ git clone git@git.mikangali.com:lab-241/appbase-server\n$ cd appbase-server\n$ npm install\n$ grunt Server is running at http://localhost:3000 Start ionic mobile app $ git clone git@git.mikangali.com:lab-241/appbase-client-ionic\n$ cd appbase-client-ionic\n$ bower install\n$ ionic serve --lab\n\n# Run ionic app on android\n\n$ ionic platform android\n$ ionic run android --livereload",
"text": "Prerequites NodeJs Install dev tools App base is built on top of ionic (who use cordova) and strongloop.\nSome others automation tools (like gulp) are required. npm install -g cordova ionic strongloop grunt-cli gulp bower karma-cli phantomjs Start app components Start loopback REST api server $ git clone git@git.mikangali.com:lab-241/appbase-server\n$ cd appbase-server\n$ npm install\n$ grunt Server is running at http://localhost:3000 Start ionic mobile app $ git clone git@git.mikangali.com:lab-241/appbase-client-ionic\n$ cd appbase-client-ionic\n$ npm install\n$ ionic serve --lab\n\n# Run ionic app on android\n\n$ ionic platform android\n$ ionic run android --livereload",
"title": "Development quick start"
},
{
......@@ -27,43 +27,108 @@
},
{
"location": "/server/install/",
"text": "Mobile app installation",
"text": "Appbase: server installation\n\n\nAppbase server is a \nloopback framwork\n project built to expose a REST API that appbase clients (like \nionic-client\n) will consumes.\n\n\nPre requistes\n\n\n\n\nNode.js\n and \nloopback framwork\n are required on your computer to start this project.\n\n\n\n\nDev tools install\n\n\nWhen \nNode.js\n is present on your environment just run following command to install Loopback.\n\n\n$ npm install -g strongloop grunt-cli\n\n\n\n\nGet + start appbase loopback server\n\n\n$ git clone git@git.mikangali.com:lab-241/appbase-server\n$ cd appbase-server\n$ npm install\n$ grunt serve\n\n\n\n\nServer is running at : \nhttp://localhost:3000\n\n\nAbout Loopback framework\n\n\nLoopback is a opensource Node.js API framework for building REST APIs for your client applications (browser, mobile, etc).\n\n\n\n\nFor more about Loopback projects, read official \ndoc",
"title": "Install"
},
{
"location": "/server/install/#mobile-app-installation",
"text": "",
"title": "Mobile app installation"
"location": "/server/install/#appbase-server-installation",
"text": "Appbase server is a loopback framwork project built to expose a REST API that appbase clients (like ionic-client ) will consumes.",
"title": "Appbase: server installation"
},
{
"location": "/server/install/#pre-requistes",
"text": "Node.js and loopback framwork are required on your computer to start this project.",
"title": "Pre requistes"
},
{
"location": "/server/install/#dev-tools-install",
"text": "When Node.js is present on your environment just run following command to install Loopback. $ npm install -g strongloop grunt-cli",
"title": "Dev tools install"
},
{
"location": "/server/install/#get-start-appbase-loopback-server",
"text": "$ git clone git@git.mikangali.com:lab-241/appbase-server\n$ cd appbase-server\n$ npm install\n$ grunt serve Server is running at : http://localhost:3000",
"title": "Get + start appbase loopback server"
},
{
"location": "/server/install/#about-loopback-framework",
"text": "Loopback is a opensource Node.js API framework for building REST APIs for your client applications (browser, mobile, etc). For more about Loopback projects, read official doc",
"title": "About Loopback framework"
},
{
"location": "/server/configure/",
"text": "REST api server installation",
"text": "REST api server configuration",
"title": "Configure"
},
{
"location": "/server/configure/#rest-api-server-installation",
"location": "/server/configure/#rest-api-server-configuration",
"text": "",
"title": "REST api server installation"
"title": "REST api server configuration"
},
{
"location": "/ionic/install/",
"text": "REST api server installation",
"text": "Appbase : Ionic mobile client installation\n\n\nAppbase \nmobile client\n is a \nionic framwork\n project built to work with the \nappbase-server\n project. This mobile client consumes the \nappbase-server\n REST api.\n\n\nPre requistes\n\n\n\n\nNode.js\n, Cordova and \nIonic-cli\n are required on your computer to start this project.\n\n\n\n\nDev tools install\n\n\nWhen \nNode.js\n is present on your environment just run following command to install appbase-ionic dev requirements.\n\n\n$ npm install -g cordova ionic grunt-cli gulp bower karma-cli phantomjs\n\n\n\n\nCAUTION\n : Before start the client, you must ensure that server is up and running. Read \ninstall server tutorial\n for instructions.\n\n\nGet + start appbase ionic\n\n\n$ git clone git@git.mikangali.com:lab-241/appbase-client-ionic\n$ cd appbase-client-ionic\n$ npm install\n$ ionic serve --lab\n\n\n\n\nRun ionic app on android device/emulator\n\n\n$ ionic platform android\n$ ionic run android --livereload\n\n\n\n\nAbout Ionic framework\n\n\nIonic is an open source mobile SDK for developing cross-platfom\n\n\n\n\nFor more about ionic projects, read official \ndoc\n.",
"title": "Install"
},
{
"location": "/ionic/install/#rest-api-server-installation",
"text": "",
"title": "REST api server installation"
"location": "/ionic/install/#appbase-ionic-mobile-client-installation",
"text": "Appbase mobile client is a ionic framwork project built to work with the appbase-server project. This mobile client consumes the appbase-server REST api.",
"title": "Appbase : Ionic mobile client installation"
},
{
"location": "/ionic/install/#pre-requistes",
"text": "Node.js , Cordova and Ionic-cli are required on your computer to start this project.",
"title": "Pre requistes"
},
{
"location": "/ionic/install/#dev-tools-install",
"text": "When Node.js 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 for instructions.",
"title": "Dev tools install"
},
{
"location": "/ionic/install/#get-start-appbase-ionic",
"text": "$ git clone git@git.mikangali.com:lab-241/appbase-client-ionic\n$ cd appbase-client-ionic\n$ npm install\n$ ionic serve --lab",
"title": "Get + start appbase ionic"
},
{
"location": "/ionic/install/#run-ionic-app-on-android-deviceemulator",
"text": "$ ionic platform android\n$ ionic run android --livereload",
"title": "Run ionic app on android device/emulator"
},
{
"location": "/ionic/install/#about-ionic-framework",
"text": "Ionic is an open source mobile SDK for developing cross-platfom For more about ionic projects, read official doc .",
"title": "About Ionic framework"
},
{
"location": "/ionic/configure/",
"text": "mobile App configuration",
"text": "Ionic mobile app configuration\n\n\nIn this section we wille lear how to setup appbase ionic conf.\nThe main config file is located at \nwww/app/conf/ConfParams.js\n.\n\n\nSetup api endpoint\n\n\nThat config make the link between the mobile app and the REST api.\n\n\nManually\n\n\nEdit \nwww/app/conf/ConfParams.js\n and change the value of \nAPI_ENDPOINT\n constant.\n\n\nUsing grunt\n\n\nThe default grunt task can be used to edit \nConfParams.js\n via env vars.\nIt use \nngconstant\n grunt plugin to edit de conf file.\n\n\nExample\n\n\nexport API_ENDPOINT=http://your-server-with-appbase.org/api \ngrunt \n ionic serve --lab",
"title": "Configure"
},
{
"location": "/ionic/configure/#mobile-app-configuration",
"text": "",
"title": "mobile App configuration"
"location": "/ionic/configure/#ionic-mobile-app-configuration",
"text": "In this section we wille lear how to setup appbase ionic conf.\nThe main config file is located at www/app/conf/ConfParams.js .",
"title": "Ionic mobile app configuration"
},
{
"location": "/ionic/configure/#setup-api-endpoint",
"text": "That config make the link between the mobile app and the REST api.",
"title": "Setup api endpoint"
},
{
"location": "/ionic/configure/#manually",
"text": "Edit www/app/conf/ConfParams.js and change the value of API_ENDPOINT constant.",
"title": "Manually"
},
{
"location": "/ionic/configure/#using-grunt",
"text": "The default grunt task can be used to edit ConfParams.js via env vars.\nIt use ngconstant grunt plugin to edit de conf file.",
"title": "Using grunt"
},
{
"location": "/ionic/configure/#example",
"text": "export API_ENDPOINT=http://your-server-with-appbase.org/api \ngrunt ionic serve --lab",
"title": "Example"
}
]
}
\ No newline at end of file
......@@ -126,14 +126,14 @@
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#rest-api-server-installation">REST api server installation</a></li>
<li class="main active"><a href="#rest-api-server-configuration">REST api server configuration</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h3 id="rest-api-server-installation">REST api server installation</h3></div>
<h3 id="rest-api-server-configuration">REST api server configuration</h3></div>
</div>
<footer class="col-md-12">
......
......@@ -126,14 +126,44 @@
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#mobile-app-installation">Mobile app installation</a></li>
<li class="main active"><a href="#appbase-server-installation">Appbase: server installation</a></li>
<li><a href="#pre-requistes">Pre requistes</a></li>
<li><a href="#dev-tools-install">Dev tools install</a></li>
<li><a href="#get-start-appbase-loopback-server">Get + start appbase loopback server</a></li>
<li><a href="#about-loopback-framework">About Loopback framework</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h3 id="mobile-app-installation">Mobile app installation</h3></div>
<h2 id="appbase-server-installation">Appbase: server installation</h2>
<p>Appbase server is a <a href="http://loopback.io">loopback framwork</a> project built to expose a REST API that appbase clients (like <a href="https://github.com/lab-241/appbase-client-ionic">ionic-client</a>) will consumes.</p>
<h3 id="pre-requistes">Pre requistes</h3>
<ul>
<li><a href="http://nodejs.org">Node.js</a> and <a href="http://loopback.io">loopback framwork</a> are required on your computer to start this project.</li>
</ul>
<h3 id="dev-tools-install">Dev tools install</h3>
<p>When <a href="http://nodejs.org">Node.js</a> is present on your environment just run following command to install Loopback.</p>
<pre><code>$ npm install -g strongloop grunt-cli
</code></pre>
<h3 id="get-start-appbase-loopback-server">Get + start appbase loopback server</h3>
<pre><code>$ git clone git@git.mikangali.com:lab-241/appbase-server
$ cd appbase-server
$ npm install
$ grunt serve
</code></pre>
<p>Server is running at : <a href="http://localhost:3000">http://localhost:3000</a></p>
<h3 id="about-loopback-framework">About Loopback framework</h3>
<p>Loopback is a opensource Node.js API framework for building REST APIs for your client applications (browser, mobile, etc).</p>
<p><img alt="" src="../../img/powered-by-LB-logo.png" /></p>
<p>For more about Loopback projects, read official <a href="http://loopback.io/getting-started/">doc</a></p></div>
</div>
<footer class="col-md-12">
......
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