quickstart.rst.txt 1.1 KB

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