zrhoffman/candidate-finder repository overview

The most straighforward way to use the candidate finder is from the
command line using `CLIPS`_.

.. code-block:: shell

    cd resources;
    clips -f2 run-from-cli.clp;

Answer each question with :code:`yes` or :code:`no`. Given enough
answers, CLIPS will eventually print a recommendation and exit.

.. _`CLIPS`: http://www.clipsrules.net/

Docker
``````

If you have `Docker`_, you can run the the CI build of the project in a
Docker container:

.. code-block:: shell

    docker run -it -p8080:8080 zrhoffman/candidate-finder;
    The candidate finder is running.
    To test, open http://localhost:8080/ in a new browser window.
    Press the "Q" key to exit.

.. _`Docker`: https://docs.docker.com/get-started/

Building
--------

In order to build the project:

1. Get the Ada Web Server sources and all of its dependencies mentioned in `AWS's documentation`_.

2. Download the `source code for the CLIPS core`_ and extract it in a directory in the project root named :code:`clips-core`. See the `AdaCLIPS documentation`_ for more information about this step.

3. Generate WBlock sources from templates. This step relies on the Templates_Parser library, a component of AWS.

   .. code-block:: shell

        make build_tpl;

4. Build the project:

   .. code-block:: shell

        gprbuild candidate_finder.gpr;

   If you get errors about anything being undefined, go back and make
   sure all of the dependencies are found by the GNAT compiler.

Once you have all of the dependencies, you can perform steps 3 and 4
quickly by running :code:`make all` or just :code:`make`.

.. _`AWS's documentation`: http://docs.adacore.com/aws-docs/aws/building_aws.html
.. _`source code for the CLIPS core`: https://sourceforge.net/p/clipsrules/code/HEAD/tree/branches/63x/core/
.. _`AdaCLIPS documentation`: https://github.com/zrhoffman/AdaCLIPS
.. _`Templates_Parser library`: http://docs.adacore.com/live/wave/aws/html/template_parser/index.html