updated docs
This commit is contained in:
parent
8d8837543b
commit
1c3376bf7b
Binary file not shown.
Binary file not shown.
BIN
documentation/build/_images/react_filter.png
Normal file
BIN
documentation/build/_images/react_filter.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 4.3 MiB |
@ -8,6 +8,9 @@ The main thing this app does is show a map, with icons for each house, while als
|
|||||||
.. figure:: react_app_example.png
|
.. figure:: react_app_example.png
|
||||||
|
|
||||||
|
|
||||||
|
The app works using the generated out.json file from the scrape project. This file is compiled in the app. This makes the loading of the App quite slow.
|
||||||
|
Also a lot of markers has some impact on the performance of the app.
|
||||||
|
|
||||||
Usage
|
Usage
|
||||||
=====
|
=====
|
||||||
Copy the generated *out.json* file that was generated in the *usse scrape* project to ``src/locations.json``, next you can run the app:
|
Copy the generated *out.json* file that was generated in the *usse scrape* project to ``src/locations.json``, next you can run the app:
|
||||||
@ -26,3 +29,25 @@ To use the dockerfile you can simply use the bash script: ``use_docker.sh`` and
|
|||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
./use_docker.sh
|
./use_docker.sh
|
||||||
|
|
||||||
|
Several commands are supported:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
./use_docker.sh remove
|
||||||
|
./use_docker.sh rebuild
|
||||||
|
|
||||||
|
Redeploy
|
||||||
|
--------
|
||||||
|
To recreate the app you can run:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
./use_docker.sh recreate
|
||||||
|
|
||||||
|
filters
|
||||||
|
-------
|
||||||
|
The app also has filters for price and distance to various locations:
|
||||||
|
|
||||||
|
.. figure:: images/react_filter.png
|
||||||
|
|
||||||
|
@ -46,7 +46,11 @@
|
|||||||
<ul class="current">
|
<ul class="current">
|
||||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">React App</a><ul>
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">React App</a><ul>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="#usage">Usage</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="#usage">Usage</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="#docker">Docker</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="#docker">Docker</a><ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#redeploy">Redeploy</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#filters">filters</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -86,6 +90,8 @@ The main thing this app does is show a map, with icons for each house, while als
|
|||||||
<figure class="align-default">
|
<figure class="align-default">
|
||||||
<img alt="_images/react_app_example.png" src="_images/react_app_example.png" />
|
<img alt="_images/react_app_example.png" src="_images/react_app_example.png" />
|
||||||
</figure>
|
</figure>
|
||||||
|
<p>The app works using the generated out.json file from the scrape project. This file is compiled in the app. This makes the loading of the App quite slow.
|
||||||
|
Also a lot of markers has some impact on the performance of the app.</p>
|
||||||
<section id="usage">
|
<section id="usage">
|
||||||
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this heading"></a></h2>
|
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this heading"></a></h2>
|
||||||
<p>Copy the generated <em>out.json</em> file that was generated in the <em>usse scrape</em> project to <code class="docutils literal notranslate"><span class="pre">src/locations.json</span></code>, next you can run the app:</p>
|
<p>Copy the generated <em>out.json</em> file that was generated in the <em>usse scrape</em> project to <code class="docutils literal notranslate"><span class="pre">src/locations.json</span></code>, next you can run the app:</p>
|
||||||
@ -101,6 +107,25 @@ To use the dockerfile you can simply use the bash script: <code class="docutils
|
|||||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./use_docker.sh
|
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./use_docker.sh
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
|
<p>Several commands are supported:</p>
|
||||||
|
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./use_docker.sh remove
|
||||||
|
./use_docker.sh rebuild
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
<section id="redeploy">
|
||||||
|
<h3>Redeploy<a class="headerlink" href="#redeploy" title="Permalink to this heading"></a></h3>
|
||||||
|
<p>To recreate the app you can run:</p>
|
||||||
|
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./use_docker.sh recreate
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section id="filters">
|
||||||
|
<h3>filters<a class="headerlink" href="#filters" title="Permalink to this heading"></a></h3>
|
||||||
|
<p>The app also has filters for price and distance to various locations:</p>
|
||||||
|
<figure class="align-default">
|
||||||
|
<img alt="_images/react_filter.png" src="_images/react_filter.png" />
|
||||||
|
</figure>
|
||||||
|
</section>
|
||||||
</section>
|
</section>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -8,6 +8,9 @@ The main thing this app does is show a map, with icons for each house, while als
|
|||||||
.. figure:: react_app_example.png
|
.. figure:: react_app_example.png
|
||||||
|
|
||||||
|
|
||||||
|
The app works using the generated out.json file from the scrape project. This file is compiled in the app. This makes the loading of the App quite slow.
|
||||||
|
Also a lot of markers has some impact on the performance of the app.
|
||||||
|
|
||||||
Usage
|
Usage
|
||||||
=====
|
=====
|
||||||
Copy the generated *out.json* file that was generated in the *usse scrape* project to ``src/locations.json``, next you can run the app:
|
Copy the generated *out.json* file that was generated in the *usse scrape* project to ``src/locations.json``, next you can run the app:
|
||||||
@ -32,4 +35,19 @@ Several commands are supported:
|
|||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
./use_docker.sh remove
|
./use_docker.sh remove
|
||||||
|
./use_docker.sh rebuild
|
||||||
|
|
||||||
|
Redeploy
|
||||||
|
--------
|
||||||
|
To recreate the app you can run:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
./use_docker.sh recreate
|
./use_docker.sh recreate
|
||||||
|
|
||||||
|
filters
|
||||||
|
-------
|
||||||
|
The app also has filters for price and distance to various locations:
|
||||||
|
|
||||||
|
.. figure:: images/react_filter.png
|
||||||
|
|
||||||
|
BIN
documentation/source/images/react_filter.png
Normal file
BIN
documentation/source/images/react_filter.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 4.3 MiB |
Loading…
Reference in New Issue
Block a user