This guide will take you through everything you need to do to have a local instance of cosr-back up and running.
Please note that we only support Linux and Mac OS X at the moment.
There are only 2 dependencies you need to install to get started:
- Docker to run containers (Installation instructions)
- git to interact with GitHub (Installation instructions)
You should make sure your Docker daemon is started. Check the Docker documentation if you are unsure how to start it. For instance on Ubuntu you may need to run sudo service docker start.
To clone this repository from GitHub, go to your local workspace directory and run:
git clone https://github.com/commonsearch/cosr-back.git
cd cosr-back
Next, there are a few Docker images available that contain all the dependencies you will need to run cosr-back. To download them from the Docker Hub, just run:
make docker_pull
Linux users: depending on your Docker install you make get a permission error with the command above. To fix it you should prefix all the docker commands by sudo, for instance: sudo make docker_pull.
Now you have a local copy of the code and of the Docker images on your machine. Congratulations!
You can now:
- Launch our test suite, to make sure your install is working fine. See tests/README.md for instructions.
- Run your first job to analyze or index the data from Common Crawl. See our tutorial.
- Contribute your first patch, see Developers: Get started.