docs/dev/quickstart.rst · searx

on master help sign in

searx/docs/dev/quickstart.rst

55 lines 1.2 kB history raw

1.. _devquickstart:

3======================

4Development Quickstart

5======================

7.. _npm: https://www.npmjs.com/

9Searx loves developers, just clone and start hacking. All the rest is done for

10you simply by using :ref:`make <makefile>`.

12.. code:: sh

14 git clone https://github.com/searx/searx.git

16Here is how a minimal workflow looks like:

181. *start* hacking

192. *run* your code: :ref:`make run`

203. *test* your code: :ref:`make test`

22If you think at some point something fails, go back to *start*. Otherwise,

23choose a meaningful commit message and we are happy to receive your pull

24request. To not end in *wild west* we have some directives, please pay attention

25to our ":ref:`how to contribute`" guideline.

27If you implement themes, you will need to compile styles and JavaScript before

28*run*.

30.. code:: sh

32 make themes

34Don't forget to install npm_ first.

36.. tabs::

38 .. group-tab:: Ubuntu / debian

40 .. code:: sh

42 sudo -H apt-get install npm

44 .. group-tab:: Arch Linux

46 .. code-block:: sh

48 sudo -H pacman -S npm

50 .. group-tab:: Fedora / RHEL

52 .. code-block:: sh

54 sudo -H dnf install npm