free
/
searx
Vērot 1
Pievienot zvaigznīti 0
Atdalīts 0
Kods Problēmas 0 Izmaiņu pieprasījumi 0 Laidieni 11 Vikivietne Aktivitāte
Pārlūkot izejas kodu

add development quickstart

Noemi Vanyi 8 gadus atpakaļ
vecāks
7483dd8877
revīzija
f943fe65bc
6 mainītis faili ar 319 papildinājumiem un 0 dzēšanām
Dalītais skats Rādīt salīdzināšanas statistiku
  1. 90
    0
      _sources/dev/quickstart.txt
  2. 1
    0
      _sources/index.txt
  3. 136
    0
      dev/quickstart.html
  4. 90
    0
      docs/dev/quickstart.rst
  5. 1
    0
      docs/index.rst
  6. 1
    0
      index.html

+ 90
- 0
_sources/dev/quickstart.txt Parādīt failu 

@@ -0,0 +1,90 @@
1 
+Development Quickstart
2 
+----------------------
3 
+
4 
+This quickstart guide gets your environment set up with searx. Furthermore, it gives a
5 
+short introduction to the new manage.sh script.
6 
+
7 
+How to setup your development environment
8 
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9 
+
10 
+First, clone the source code of searx to the desired folder. In this case the source
11 
+is cloned to ~/myprojects/searx. Then create and activate the searx-ve
12 
+virtualenv and install the required packages using manage.sh.
13 
+
14 
+.. code:: sh
15 
+
16 
+    cd ~/myprojects
17 
+    git clone https://github.com/asciimoo/searx.git
18 
+    cd searx
19 
+    virtualenv searx-ve
20 
+    . ./searx-ve/bin/activate
21 
+    ./manage.sh update_dev_packages
22 
+
23 
+
24 
+How to run tests
25 
+~~~~~~~~~~~~~~~~
26 
+
27 
+Tests can be run using the manage.sh script.
28 
+
29 
+Following tests and checks are available:
30 
+
31 
+- Unit tests
32 
+
33 
+- Selenium tests
34 
+
35 
+- PEP8 validation
36 
+
37 
+- Unit test coverage check
38 
+
39 
+For example unit tests are run with the command below:
40 
+
41 
+.. code:: sh
42 
+
43 
+    ./manage.sh unit_tests
44 
+
45 
+For further test options, please consult the help of the manage.sh script.
46 
+
47 
+
48 
+How to compile styles and javascript
49 
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
50 
+
51 
+How to build styles
52 
+^^^^^^^^^^^^^^^^^^^
53 
+
54 
+Less is required to build the styles of searx. Less can be installed using either NodeJS or Apt.
55 
+
56 
+.. code:: sh
57 
+
58 
+    sudo apt-get install nodejs
59 
+    sudo npm install -g less
60 
+
61 
+
62 
+OR
63 
+
64 
+.. code:: sh
65 
+
66 
+    sudo apt-get install node-less
67 
+
68 
+After satisfying the requirements styles can be build using manage.sh
69 
+
70 
+.. code:: sh
71 
+
72 
+    ./manage.sh styles
73 
+
74 
+
75 
+How to build the source of the oscar theme
76 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
77 
+
78 
+Grunt must be installed in order to build the javascript sources. It depends on NodeJS, so first
79 
+Node has to be installed.
80 
+
81 
+.. code:: sh
82 
+
83 
+    sudo apt-get install nodejs
84 
+    sudo npm install -g grunt-cli
85 
+
86 
+After installing grunt, the files can be built using the following command:
87 
+
88 
+.. code:: sh
89 
+
90 
+    ./manage.sh build_grunt

+ 1
- 0
_sources/index.txt Parādīt failu 

@@ -32,6 +32,7 @@ Developer documentation
32 32 
 .. toctree::
33 33 
    :maxdepth: 1
34 34
35 
+   dev/quickstart
35 36 
    dev/contribution_guide
36 37 
    dev/install/installation
37 38 
    dev/engine_overview

+ 136
- 0
dev/quickstart.html Parādīt failu 

@@ -0,0 +1,136 @@
1 
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 
+
4 
+
5 
+<html xmlns="http://www.w3.org/1999/xhtml">
6 
+  <head>
7 
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8 
+
9 
+    <title>Development Quickstart &mdash; searx 0.8.0 documentation</title>
10 
+
11 
+    <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12 
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13 
+
14 
+    <script type="text/javascript">
15 
+      var DOCUMENTATION_OPTIONS = {
16 
+        URL_ROOT:    '../',
17 
+        VERSION:     '0.8.0',
18 
+        COLLAPSE_INDEX: false,
19 
+        FILE_SUFFIX: '.html',
20 
+        HAS_SOURCE:  true
21 
+      };
22 
+    </script>
23 
+    <script type="text/javascript" src="../_static/jquery.js"></script>
24 
+    <script type="text/javascript" src="../_static/underscore.js"></script>
25 
+    <script type="text/javascript" src="../_static/doctools.js"></script>
26 
+    <link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
27 
+
28 
+
29 
+  <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
30 
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
31 
+
32 
+  </head>
33 
+  <body role="document">
34 
+
35 
+    <div class="document">
36 
+      <div class="documentwrapper">
37 
+        <div class="bodywrapper">
38 
+          <div class="body" role="main">
39 
+
40 
+  <div class="section" id="development-quickstart">
41 
+<h1>Development Quickstart<a class="headerlink" href="#development-quickstart" title="Permalink to this headline">¶</a></h1>
42 
+<p>This quickstart guide gets your environment set up with searx. Furthermore, it gives a
43 
+short introduction to the new manage.sh script.</p>
44 
+<div class="section" id="how-to-setup-your-development-environment">
45 
+<h2>How to setup your development environment<a class="headerlink" href="#how-to-setup-your-development-environment" title="Permalink to this headline">¶</a></h2>
46 
+<p>First, clone the source code of searx to the desired folder. In this case the source
47 
+is cloned to ~/myprojects/searx. Then create and activate the searx-ve
48 
+virtualenv and install the required packages using manage.sh.</p>
49 
+<div class="code sh highlight-python"><div class="highlight"><pre>cd ~/myprojects
50 
+git clone https://github.com/asciimoo/searx.git
51 
+cd searx
52 
+virtualenv searx-ve
53 
+. ./searx-ve/bin/activate
54 
+./manage.sh update_dev_packages
55 
+</pre></div>
56 
+</div>
57 
+</div>
58 
+<div class="section" id="how-to-run-tests">
59 
+<h2>How to run tests<a class="headerlink" href="#how-to-run-tests" title="Permalink to this headline">¶</a></h2>
60 
+<p>Tests can be run using the manage.sh script.</p>
61 
+<p>Following tests and checks are available:</p>
62 
+<ul class="simple">
63 
+<li>Unit tests</li>
64 
+<li>Selenium tests</li>
65 
+<li>PEP8 validation</li>
66 
+<li>Unit test coverage check</li>
67 
+</ul>
68 
+<p>For example unit tests are run with the command below:</p>
69 
+<div class="code sh highlight-python"><div class="highlight"><pre>./manage.sh unit_tests
70 
+</pre></div>
71 
+</div>
72 
+<p>For further test options, please consult the help of the manage.sh script.</p>
73 
+</div>
74 
+<div class="section" id="how-to-compile-styles-and-javascript">
75 
+<h2>How to compile styles and javascript<a class="headerlink" href="#how-to-compile-styles-and-javascript" title="Permalink to this headline">¶</a></h2>
76 
+<div class="section" id="how-to-build-styles">
77 
+<h3>How to build styles<a class="headerlink" href="#how-to-build-styles" title="Permalink to this headline">¶</a></h3>
78 
+<p>Less is required to build the styles of searx. Less can be installed using either NodeJS or Apt.</p>
79 
+<div class="code sh highlight-python"><div class="highlight"><pre>sudo apt-get install nodejs
80 
+sudo npm install -g less
81 
+</pre></div>
82 
+</div>
83 
+<p>OR</p>
84 
+<div class="code sh highlight-python"><div class="highlight"><pre>sudo apt-get install node-less
85 
+</pre></div>
86 
+</div>
87 
+<p>After satisfying the requirements styles can be build using manage.sh</p>
88 
+<div class="code sh highlight-python"><div class="highlight"><pre>./manage.sh styles
89 
+</pre></div>
90 
+</div>
91 
+</div>
92 
+<div class="section" id="how-to-build-the-source-of-the-oscar-theme">
93 
+<h3>How to build the source of the oscar theme<a class="headerlink" href="#how-to-build-the-source-of-the-oscar-theme" title="Permalink to this headline">¶</a></h3>
94 
+<p>Grunt must be installed in order to build the javascript sources. It depends on NodeJS, so first
95 
+Node has to be installed.</p>
96 
+<div class="code sh highlight-python"><div class="highlight"><pre>sudo apt-get install nodejs
97 
+sudo npm install -g grunt-cli
98 
+</pre></div>
99 
+</div>
100 
+<p>After installing grunt, the files can be built using the following command:</p>
101 
+<div class="code sh highlight-python"><div class="highlight"><pre>./manage.sh build_grunt
102 
+</pre></div>
103 
+</div>
104 
+</div>
105 
+</div>
106 
+</div>
107 
+
108 
+
109 
+          </div>
110 
+        </div>
111 
+      </div>
112 
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
113 
+        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
114 
+<h1>Searx</h1>
115 
+<ul>
116 
+    <li><a href="../index.html">Home</a></li>
117 
+    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
118 
+    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
119 
+    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
120 
+</ul>
121 
+<hr />
122 
+<ul>
123 
+    <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
124 
+    <li><a href="https://flattr.com/submit/auto?user_id=asciimoo&url=https://github.com/asciimoo/searx&title=searx&language=&tags=github&category=software">Flattr</a></li>
125 
+    <li><a href="https://gratipay.com/searx">Gratipay</a></li>
126 
+</ul>
127 
+</div>
128 
+        </div>
129 
+      </div>
130 
+      <div class="clearer"></div>
131 
+    </div>
132 
+    <div class="footer">
133 
+      &copy; Copyright 2015, Adam Tauber.
134 
+    </div>
135 
+  </body>
136 
+</html>

+ 90
- 0
docs/dev/quickstart.rst Parādīt failu 

@@ -0,0 +1,90 @@
1 
+Development Quickstart
2 
+----------------------
3 
+
4 
+This quickstart guide gets your environment set up with searx. Furthermore, it gives a
5 
+short introduction to the new manage.sh script.
6 
+
7 
+How to setup your development environment
8 
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9 
+
10 
+First, clone the source code of searx to the desired folder. In this case the source
11 
+is cloned to ~/myprojects/searx. Then create and activate the searx-ve
12 
+virtualenv and install the required packages using manage.sh.
13 
+
14 
+.. code:: sh
15 
+
16 
+    cd ~/myprojects
17 
+    git clone https://github.com/asciimoo/searx.git
18 
+    cd searx
19 
+    virtualenv searx-ve
20 
+    . ./searx-ve/bin/activate
21 
+    ./manage.sh update_dev_packages
22 
+
23 
+
24 
+How to run tests
25 
+~~~~~~~~~~~~~~~~
26 
+
27 
+Tests can be run using the manage.sh script.
28 
+
29 
+Following tests and checks are available:
30 
+
31 
+- Unit tests
32 
+
33 
+- Selenium tests
34 
+
35 
+- PEP8 validation
36 
+
37 
+- Unit test coverage check
38 
+
39 
+For example unit tests are run with the command below:
40 
+
41 
+.. code:: sh
42 
+
43 
+    ./manage.sh unit_tests
44 
+
45 
+For further test options, please consult the help of the manage.sh script.
46 
+
47 
+
48 
+How to compile styles and javascript
49 
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
50 
+
51 
+How to build styles
52 
+^^^^^^^^^^^^^^^^^^^
53 
+
54 
+Less is required to build the styles of searx. Less can be installed using either NodeJS or Apt.
55 
+
56 
+.. code:: sh
57 
+
58 
+    sudo apt-get install nodejs
59 
+    sudo npm install -g less
60 
+
61 
+
62 
+OR
63 
+
64 
+.. code:: sh
65 
+
66 
+    sudo apt-get install node-less
67 
+
68 
+After satisfying the requirements styles can be build using manage.sh
69 
+
70 
+.. code:: sh
71 
+
72 
+    ./manage.sh styles
73 
+
74 
+
75 
+How to build the source of the oscar theme
76 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
77 
+
78 
+Grunt must be installed in order to build the javascript sources. It depends on NodeJS, so first
79 
+Node has to be installed.
80 
+
81 
+.. code:: sh
82 
+
83 
+    sudo apt-get install nodejs
84 
+    sudo npm install -g grunt-cli
85 
+
86 
+After installing grunt, the files can be built using the following command:
87 
+
88 
+.. code:: sh
89 
+
90 
+    ./manage.sh build_grunt

+ 1
- 0
docs/index.rst Parādīt failu 

@@ -32,6 +32,7 @@ Developer documentation
32 32 
 .. toctree::
33 33 
    :maxdepth: 1
34 34
35 
+   dev/quickstart
35 36 
    dev/contribution_guide
36 37 
    dev/install/installation
37 38 
    dev/engine_overview

+ 1
- 0
index.html Parādīt failu 

@@ -68,6 +68,7 @@
68 68 
 <h2>Developer documentation<a class="headerlink" href="#developer-documentation" title="Permalink to this headline">¶</a></h2>
69 69 
 <div class="toctree-wrapper compound">
70 70 
 <ul>
71 
+<li class="toctree-l1"><a class="reference internal" href="dev/quickstart.html">Development Quickstart</a></li>
71 72 
 <li class="toctree-l1"><a class="reference internal" href="dev/contribution_guide.html">How to contribute</a></li>
72 73 
 <li class="toctree-l1"><a class="reference internal" href="dev/install/installation.html">Installation</a></li>
73 74 
 <li class="toctree-l1"><a class="reference internal" href="dev/engine_overview.html">Engine overview</a></li>