Merge pull request #127 from tubone24/add_typescript

Update Readme and Docs

README.rst

@@ -261,7 +261,9 @@ Vue.js Frontend App
 
 Using Vue.js, Call REST API.
 
-`ebook-homebrew-vue-client <https://github.com/tubone24/ebook-homebrew-vue-client>`_
+`ebook-homebrew-vue-client (deprecated) <https://github.com/tubone24/ebook-homebrew-vue-client>`_
+
+`ebook-homebrew-vue-typescript-client  <https://github.com/tubone24/ebook-homebrew-vue-typescript-client>`_
 
 
 

doc_src/client.rst

@@ -0,0 +1,100 @@
+Client
+======
+
+Example Client App
+------------------
+
+You can use Ebook Homebrew Rest API for example client app.
+
+.. note::
+
+    Examples App use ebook-homebrew demo heroku endpoint.
+    If you use your own server, fork the code and change the backend URL.
+
+Git clone Example app with :command:`git clone `::
+
+    $ git clone https://github.com/tubone24/ebook_homebrew.git
+    $ git submodule update --init --recursive
+
+
+Stand Alone Web GUI
+^^^^^^^^^^^^^^^^^^^
+
+The basic WEB app which create PDF from your images built in the ebook-homebrew.
+
+Install **Flask** and Execute commands below. ::
+
+  $ cd examples/web_gui/
+  $ pip install requirements.txt
+  $ cd src
+  $ python application.py
+
+And Access `localhost:8080 <http://localhost:8080>`_
+
+You can see The TOP page like blow. Click **GO DEMO APP**
+
+.. image:: standalone-top.png
+
+Choose Files, digits and extension. Click **Create!** and Downloading **result.pdf**
+
+.. image:: standalone-choose-img.png
+
+Command Line Tools with using Rest API
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Client App with ebook-homebrew's rest API interface.
+Install **requests** and **docopt** and Execute. ::
+
+  $ cd examples/use_rest_api/
+  $ pip install requirements.txt
+  $ cd src
+  $ python main.py -h
+
+You can see the CLI's Usage.
+
+Android App
+^^^^^^^^^^^
+
+.. warning:: This app is created flutter, so you can build an Android app and an iOS app,
+but I don't try to build ios app, because I don't have ios.
+
+Demo client Native App for using ebook-homebrew.
+
+Install Flutter SDK and Build App::
+
+  $ cd examples/ebook-homebrew-android-app
+  $ git clone -b beta https://github.com/flutter/flutter.git ~/flutter
+  $ cat YOUR_APP_KEY > android/app/apk_key.jks
+  $ cat YOUR_APP_PROPS > android/key.properties
+  $ ~/flutter/bin/flutter build apk --release --split-per-abi
+
+Also you can use Demo app downloading to `Deploy Gate <https://deploygate.com/distributions/14a12d44f5909adf23f0c550f960364d4b02aad0>`_
+
+Or Download `Google Play <https://play.google.com/store/apps/details?id=com.tubone.ebook_homebrew_flutter>`_
+
+Run App and Enjoy!
+
+.. image:: flutter-android.gif
+
+Web Front App (Vue.js)
+^^^^^^^^^^^^^^^^^^^^^^
+
+.. warning:: ebook-homebrew-vue-client is Deprecated instead of ebook-homebrew-vue-typescript-client
+
+If you want to use Web Front App, you can make reference of Example app building for Vue.js.
+
+You can see 2 examples, **Vue.js with Javascript** or **Vue.js with Typescript**
+
+`Vue.js with Javascript <https://github.com/tubone24/ebook-homebrew-vue-client>`_
+
+`Vue.js with Typescript <https://github.com/tubone24/ebook-homebrew-vue-typescript-client>`_
+
+Install Node.js and NPM and Execute it::
+
+  $ cd examples/ebook-homebrew-vue-typescript-client
+  $ npm install
+  $ npm run serve
+
+Run App and Enjoy!
+
+.. image:: vue-sample.gif

doc_src/index.rst

@@ -108,6 +108,7 @@ Badges:
    overview.rst
    howtouse.rst
    restapi.rst
+   crient.rst
    deploy2heroku.rst
    releasenotes/index.rst
 

docs/_modules/ebook_homebrew/rest.html

@@ -181,7 +181,6 @@ <h1>Source code for ebook_homebrew.rest</h1><div class="highlight"><pre>
     <span class="p">},</span>
     <span class="n">version</span><span class="o">=</span><span class="n">__version__</span><span class="p">,</span>
     <span class="n">static_dir</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="vm">__file__</span><span class="p">)),</span> <span class="s2">&quot;static&quot;</span><span class="p">),</span>
-    <span class="n">static_route</span><span class="o">=</span><span class="s2">&quot;/static&quot;</span><span class="p">,</span>
     <span class="n">openapi</span><span class="o">=</span><span class="s2">&quot;3.0.2&quot;</span><span class="p">,</span>
     <span class="n">docs_route</span><span class="o">=</span><span class="s2">&quot;/docs&quot;</span><span class="p">,</span>
     <span class="n">openapi_route</span><span class="o">=</span><span class="s2">&quot;/schema.yml&quot;</span><span class="p">,</span>

docs/_sources/client.rst.txt

@@ -0,0 +1,100 @@
+Client
+======
+
+Example Client App
+------------------
+
+You can use Ebook Homebrew Rest API for example client app.
+
+.. note::
+
+    Examples App use ebook-homebrew demo heroku endpoint.
+    If you use your own server, fork the code and change the backend URL.
+
+Git clone Example app with :command:`git clone `::
+
+    $ git clone https://github.com/tubone24/ebook_homebrew.git
+    $ git submodule update --init --recursive
+
+
+Stand Alone Web GUI
+^^^^^^^^^^^^^^^^^^^
+
+The basic WEB app which create PDF from your images built in the ebook-homebrew.
+
+Install **Flask** and Execute commands below. ::
+
+  $ cd examples/web_gui/
+  $ pip install requirements.txt
+  $ cd src
+  $ python application.py
+
+And Access `localhost:8080 <http://localhost:8080>`_
+
+You can see The TOP page like blow. Click **GO DEMO APP**
+
+.. image:: standalone-top.png
+
+Choose Files, digits and extension. Click **Create!** and Downloading **result.pdf**
+
+.. image:: standalone-choose-img.png
+
+Command Line Tools with using Rest API
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Client App with ebook-homebrew's rest API interface.
+Install **requests** and **docopt** and Execute. ::
+
+  $ cd examples/use_rest_api/
+  $ pip install requirements.txt
+  $ cd src
+  $ python main.py -h
+
+You can see the CLI's Usage.
+
+Android App
+^^^^^^^^^^^
+
+.. warning:: This app is created flutter, so you can build an Android app and an iOS app,
+but I don't try to build ios app, because I don't have ios.
+
+Demo client Native App for using ebook-homebrew.
+
+Install Flutter SDK and Build App::
+
+  $ cd examples/ebook-homebrew-android-app
+  $ git clone -b beta https://github.com/flutter/flutter.git ~/flutter
+  $ cat YOUR_APP_KEY > android/app/apk_key.jks
+  $ cat YOUR_APP_PROPS > android/key.properties
+  $ ~/flutter/bin/flutter build apk --release --split-per-abi
+
+Also you can use Demo app downloading to `Deploy Gate <https://deploygate.com/distributions/14a12d44f5909adf23f0c550f960364d4b02aad0>`_
+
+Or Download `Google Play <https://play.google.com/store/apps/details?id=com.tubone.ebook_homebrew_flutter>`_
+
+Run App and Enjoy!
+
+.. image:: flutter-android.gif
+
+Web Front App (Vue.js)
+^^^^^^^^^^^^^^^^^^^^^^
+
+.. warning:: ebook-homebrew-vue-client is Deprecated instead of ebook-homebrew-vue-typescript-client
+
+If you want to use Web Front App, you can make reference of Example app building for Vue.js.
+
+You can see 2 examples, **Vue.js with Javascript** or **Vue.js with Typescript**
+
+`Vue.js with Javascript <https://github.com/tubone24/ebook-homebrew-vue-client>`_
+
+`Vue.js with Typescript <https://github.com/tubone24/ebook-homebrew-vue-typescript-client>`_
+
+Install Node.js and NPM and Execute it::
+
+  $ cd examples/ebook-homebrew-vue-typescript-client
+  $ npm install
+  $ npm run serve
+
+Run App and Enjoy!
+
+.. image:: vue-sample.gif

docs/_sources/index.rst.txt

@@ -108,6 +108,7 @@ Badges:
    overview.rst
    howtouse.rst
    restapi.rst
+   crient.rst
    deploy2heroku.rst
    releasenotes/index.rst