searx/docs/dev/quickstart.rst

56 lines
1.1 KiB
ReStructuredText
Raw Normal View History

2016-04-21 13:15:04 +02:00
.. _devquickstart:
======================
2016-02-01 21:28:13 +01:00
Development Quickstart
======================
2016-02-01 21:28:13 +01:00
.. _npm: https://www.npmjs.com/
Searx loves developers, just clone and start hacking. All the rest is done for
you simply by using :ref:`make <makefile>`.
2016-02-01 21:28:13 +01:00
.. code:: sh
git clone https://github.com/searx/searx.git
2016-02-01 21:28:13 +01:00
Here is how a minimal workflow looks like:
1. *start* hacking
2. *run* your code: :ref:`make run`
3. *test* your code: :ref:`make test`
2016-02-01 21:28:13 +01:00
If you think at some point something fails, go back to *start*. Otherwise,
choose a meaningful commit message and we are happy to receive your pull
request. To not end in *wild west* we have some directives, please pay attention
to our ":ref:`how to contribute`" guideline.
2016-02-01 21:28:13 +01:00
If you implement themes, you will need to compile styles and JavaScript before
*run*.
2016-02-01 21:28:13 +01:00
.. code:: sh
make themes
2016-02-01 21:28:13 +01:00
Don't forget to install npm_ first.
2016-02-01 21:28:13 +01:00
.. tabs::
2016-02-01 21:28:13 +01:00
.. group-tab:: Ubuntu / debian
2016-02-01 21:28:13 +01:00
.. code:: sh
2016-04-21 13:15:04 +02:00
sudo -H apt-get install npm
2016-04-21 13:15:04 +02:00
.. group-tab:: Arch Linux
.. code-block:: sh
sudo -H pacman -S npm
.. group-tab:: Fedora / RHEL
.. code-block:: sh
sudo -H dnf install npm