zaclys/searxng
1
0
Fork 1
mirror of https://github.com/searxng/searxng synced 2024-01-01 19:24:07 +01:00
Code Issues Projects Releases Packages Wiki Activity
searxng/docs/dev/quickstart.rst
Markus Heiser ea62df1dc0 [doc] update developer quickstart guide 
See https://github.com/searx/searx/issues/2369#issuecomment-740652878

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-12-12 20:31:49 +01:00

1.1 KiB
Raw Blame History

Development Quickstart

Searx loves developers, just clone and start hacking. All the rest is done for you simply by using make <makefile>.

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

Here is how a minimal workflow looks like:

  1. start hacking
  2. run your code: make run
  3. test your code: make test

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 "how to contribute" guideline.

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

make themes

Don't forget to install npm first.

Ubuntu / debian

sudo -H apt-get install npm

Arch Linux

sudo -H pacman -S npm

Fedora / RHEL

sudo -H dnf install npm