2017-06-12 12:34:30 +02:00
2019-12-30 18:31:17 +01:00
<!DOCTYPE html>
2016-02-01 21:28:13 +01:00
2020-06-19 11:15:15 +02:00
< html >
2016-02-01 21:28:13 +01:00
< head >
2019-12-30 18:31:17 +01:00
< meta charset = "utf-8" / >
2020-09-30 10:35:05 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2019-12-30 18:31:17 +01:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
2020-12-14 19:16:25 +01:00
< title > Development Quickstart — Searx Documentation (Searx-0.18.0.tex)< / title >
2019-12-30 18:31:17 +01:00
< link rel = "stylesheet" href = "../_static/searx.css" type = "text/css" / >
2016-02-01 21:28:13 +01:00
< link rel = "stylesheet" href = "../_static/pygments.css" type = "text/css" / >
2020-09-30 10:35:05 +02:00
< link rel = "stylesheet" type = "text/css" href = "../_static/sphinx_tabs/semantic-ui-2.4.1/segment.min.css" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/sphinx_tabs/semantic-ui-2.4.1/menu.min.css" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/sphinx_tabs/semantic-ui-2.4.1/tab.min.css" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/sphinx_tabs/tabs.css" / >
2020-02-15 10:08:58 +01:00
< script id = "documentation_options" data-url_root = "../" src = "../_static/documentation_options.js" > < / script >
< script src = "../_static/jquery.js" > < / script >
< script src = "../_static/underscore.js" > < / script >
< script src = "../_static/doctools.js" > < / script >
< script src = "../_static/language_data.js" > < / script >
2020-12-14 18:19:24 +01:00
< script src = "../_static/sphinx_tabs/semantic-ui-2.4.1/tab.min.js" > < / script >
< script src = "../_static/sphinx_tabs/tabs.js" > < / script >
2016-11-04 21:56:14 +01:00
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
2016-04-21 13:15:04 +02:00
< link rel = "next" title = "How to contribute" href = "contribution_guide.html" / >
2019-12-30 18:31:17 +01:00
< link rel = "prev" title = "Developer documentation" href = "index.html" / >
< script > DOCUMENTATION _OPTIONS . URL _ROOT = '../' ; < / script >
2016-02-01 21:28:13 +01:00
2019-12-30 18:31:17 +01:00
< / head > < body >
< div class = "related" role = "navigation" aria-label = "related navigation" >
< h3 > Navigation< / h3 >
< ul >
< li class = "right" style = "margin-right: 10px" >
< a href = "../genindex.html" title = "General Index"
accesskey="I">index< / a > < / li >
2020-11-04 14:12:59 +01:00
< li class = "right" >
< a href = "../py-modindex.html" title = "Python Module Index"
>modules< / a > |< / li >
2019-12-30 18:31:17 +01:00
< li class = "right" >
< a href = "contribution_guide.html" title = "How to contribute"
accesskey="N">next< / a > |< / li >
< li class = "right" >
< a href = "index.html" title = "Developer documentation"
accesskey="P">previous< / a > |< / li >
2020-12-14 19:16:25 +01:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Searx Documentation (Searx-0.18.0.tex)< / a > » < / li >
2020-09-30 10:35:05 +02:00
< li class = "nav-item nav-item-1" > < a href = "index.html" accesskey = "U" > Developer documentation< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > Development Quickstart< / a > < / li >
2019-12-30 18:31:17 +01:00
< / ul >
< / div >
2016-02-01 21:28:13 +01:00
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
< div class = "section" id = "development-quickstart" >
2016-04-21 13:15:04 +02:00
< span id = "devquickstart" > < / span > < h1 > Development Quickstart< a class = "headerlink" href = "#development-quickstart" title = "Permalink to this headline" > ¶< / a > < / h1 >
2020-12-14 18:19:24 +01:00
< p > Searx loves developers, just clone and start hacking. All the rest is done for
you simply by using < a class = "reference internal" href = "makefile.html#makefile" > < span class = "std std-ref" > make< / span > < / a > .< / p >
< div class = "highlight-sh notranslate" > < div class = "highlight" > < pre > < span > < / span > git clone https://github.com/searx/searx.git
2016-02-01 21:28:13 +01:00
< / pre > < / div >
< / div >
2020-12-14 18:19:24 +01:00
< p > Here is how a minimal workflow looks like:< / p >
< ol class = "arabic simple" >
< li > < p > < em > start< / em > hacking< / p > < / li >
< li > < p > < em > run< / em > your code: < a class = "reference internal" href = "makefile.html#make-run" > < span class = "std std-ref" > make run< / span > < / a > < / p > < / li >
< li > < p > < em > test< / em > your code: < a class = "reference internal" href = "makefile.html#make-test" > < span class = "std std-ref" > make test< / span > < / a > < / p > < / li >
< / ol >
< p > If you think at some point something fails, go back to < em > start< / em > . Otherwise,
choose a meaningful commit message and we are happy to receive your pull
request. To not end in < em > wild west< / em > we have some directives, please pay attention
to our “< a class = "reference internal" href = "contribution_guide.html#how-to-contribute" > < span class = "std std-ref" > How to contribute< / span > < / a > ” guideline.< / p >
< p > If you implement themes, you will need to compile styles and JavaScript before
< em > run< / em > .< / p >
< div class = "highlight-sh notranslate" > < div class = "highlight" > < pre > < span > < / span > make themes
2016-02-01 21:28:13 +01:00
< / pre > < / div >
< / div >
2020-12-14 18:19:24 +01:00
< p > Don’ < a class = "reference external" href = "https://www.npmjs.com/" > npm< / a > first.< / p >
< div class = "sphinx-tabs docutils container" >
< div class = "ui top attached tabular menu sphinx-menu docutils container" >
< div class = "active item sphinx-data-tab-VWJ1bnR1IC8gZGViaWFu docutils container" >
< div class = "docutils container" >
< p > Ubuntu / debian< / p >
2016-02-01 21:28:13 +01:00
< / div >
< / div >
2020-12-14 18:19:24 +01:00
< div class = "item sphinx-data-tab-QXJjaCBMaW51eA== docutils container" >
< div class = "docutils container" >
< p > Arch Linux< / p >
< / div >
2016-02-01 21:28:13 +01:00
< / div >
2020-12-14 18:19:24 +01:00
< div class = "item sphinx-data-tab-RmVkb3JhIC8gUkhFTA== docutils container" >
< div class = "docutils container" >
< p > Fedora / RHEL< / p >
2016-02-01 21:28:13 +01:00
< / div >
2019-12-30 18:31:17 +01:00
< / div >
2020-12-14 18:19:24 +01:00
< / div >
< div class = "ui bottom attached sphinx-tab tab segment sphinx-data-tab-VWJ1bnR1IC8gZGViaWFu active docutils container" >
< div class = "highlight-sh notranslate" > < div class = "highlight" > < pre > < span > < / span > sudo -H apt-get install npm
2016-02-01 21:28:13 +01:00
< / pre > < / div >
< / div >
2020-12-14 18:19:24 +01:00
< / div >
< div class = "ui bottom attached sphinx-tab tab segment sphinx-data-tab-QXJjaCBMaW51eA== docutils container" >
< div class = "highlight-sh notranslate" > < div class = "highlight" > < pre > < span > < / span > sudo -H pacman -S npm
< / pre > < / div >
< / div >
< / div >
< div class = "ui bottom attached sphinx-tab tab segment sphinx-data-tab-RmVkb3JhIC8gUkhFTA== docutils container" >
< div class = "highlight-sh notranslate" > < div class = "highlight" > < pre > < span > < / span > sudo -H dnf install npm
2016-02-01 21:28:13 +01:00
< / pre > < / div >
< / div >
< / div >
2016-04-21 13:15:04 +02:00
< / div >
2016-02-01 21:28:13 +01:00
< / div >
2020-09-30 10:35:05 +02:00
< div class = "clearer" > < / div >
2016-02-01 21:28:13 +01:00
< / div >
< / div >
< / div >
2019-12-30 18:31:17 +01:00
< span id = "sidebar-top" > < / span >
2016-02-01 21:28:13 +01:00
< div class = "sphinxsidebar" role = "navigation" aria-label = "main navigation" >
2019-12-30 18:31:17 +01:00
< div class = "sphinxsidebarwrapper" >
< p class = "logo" > < a href = "../index.html" >
< img class = "logo" src = "../_static/searx_logo_small.png" alt = "Logo" / >
< / a > < / p >
< h3 > Project Links< / h3 >
< ul >
2020-09-30 10:35:05 +02:00
< li > < a href = "https://github.com/searx/searx" > Source< / a >
2019-12-30 18:31:17 +01:00
2020-09-30 10:35:05 +02:00
< li > < a href = "https://github.com/searx/searx/wiki" > Wiki< / a >
2019-12-30 18:31:17 +01:00
2020-02-15 10:08:58 +01:00
< li > < a href = "https://searx.space/" > Public instances< / a >
2019-12-30 18:31:17 +01:00
< li > < a href = "https://twitter.com/Searx_engine" > Twitter< / a >
< / ul > < h3 > Navigation< / h3 >
2016-02-01 21:28:13 +01:00
< ul >
2019-12-30 18:31:17 +01:00
< li > < a href = "../index.html" > Overview< / a >
< ul >
< li > < a href = "index.html" > Developer documentation< / a >
< ul >
< li > Previous: < a href = "index.html" title = "previous chapter" > Developer documentation< / a >
< li > Next: < a href = "contribution_guide.html" title = "next chapter" > How to contribute< / a > < / ul >
< / li >
< / ul >
< / li >
2016-02-01 21:28:13 +01:00
< / ul >
2019-12-30 18:31:17 +01:00
< div id = "searchbox" style = "display: none" role = "search" >
< h3 id = "searchlabel" > Quick search< / h3 >
< div class = "searchformwrapper" >
< form class = "search" action = "../search.html" method = "get" >
< input type = "text" name = "q" aria-labelledby = "searchlabel" / >
< input type = "submit" value = "Go" / >
< / form >
< / div >
2016-02-01 21:28:13 +01:00
< / div >
2020-02-15 10:08:58 +01:00
< script > $ ( '#searchbox' ) . show ( 0 ) ; < / script >
2016-02-01 21:28:13 +01:00
< / div >
< / div >
< div class = "clearer" > < / div >
< / div >
2019-12-30 18:31:17 +01:00
< div class = "footer" role = "contentinfo" >
2020-02-20 19:32:55 +01:00
© Copyright 2015-2020, Adam Tauber, Noémi Ványi.
2020-09-30 10:35:05 +02:00
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 3.2.1.
2016-02-01 21:28:13 +01:00
< / div >
2020-02-15 10:08:58 +01:00
< script src = "../_static/version_warning_offset.js" > < / script >
2019-12-30 18:31:17 +01:00
2016-02-01 21:28:13 +01:00
< / body >
< / html >
