eea.facetednavigation 16.5__tar.gz

eea_facetednavigation-16.5/CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# How to contribute
+
+To start, is important to mention that we keep all EEA pacakges under EEA Organisation
+on GitHub (https://github.com/eea) and we fork them to Collective so everyone can
+contribute to them. We keep the repositories from Collective and EEA in sync.
+
+We want to keep it as easy as possible to contribute changes that
+get things working. There are a few guidelines that we
+need contributors to follow so that we can have a chance of keeping on
+top of things.
+
+## Getting Started
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* If you need to submit a ticket do it under EEA Organisation area (https://github.com/eea)
+  under the respective package, e.g. https://github.com/eea/eea.facetednavigation/issues
+* Submit a ticket for your issue, assuming one does not already exist.
+  * Clearly describe the issue including steps to reproduce when it is a bug.
+  * If case state the browser and operating system used.
+* We also keep a discussion lists for most of the public packages under Google Groups.
+
+Please note that adding a bug report or feature request in the EEA github does not
+automatically mean that EEA will work on them, since there are budget implications.
+
+The issues/features registered in github are regarded only as community requests and
+here to facilitate the Plone community contributions.
+
+EEA will work directly on the Plone community's requests when they coincide with
+EEA's planned projects. In this case we will transfer the ticket to the EEA
+official issue register.
+
+## Making Changes
+
+* Fork the repository from EEA or directly commit within Collective fork
+* Make sure you added an entry under HISTORY.txt describing your changes
+* Make sure you have added the necessary tests for your changes (do not forget major browsers).
+* Make sure you have updated and added documentation when necessary.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+
+## Submitting Changes
+
+* Push your changes in your fork of the repository.
+* Submit a pull request to the upstream repository (EEA).
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+* [EEA packages](https://eea.github.io/docs/IT-systems/)

eea_facetednavigation-16.5/DEVELOP.md

@@ -0,0 +1,139 @@
+# EEA Faceted Navigation
+
+## Documentation
+
+Trainings on how to create your own website using Plone 6 is available as part of the Plone training at [https://training.plone.org](https://training.plone.org).
+
+## Pre-requirements
+
+* Python **3.7, 3.8, 3.9**
+* Python **python-venv** and **python-dev**
+* Node 16 / Yarn (See https://6.dev-docs.plone.org/volto/getting-started)
+* Libraries
+  - **libz**
+  - **libjpeg**
+  - **readline**
+  - **libexpat**
+  - **libssl** or **openssl**
+  - **libxml2**
+  - **libxslt**
+
+### Ubuntu / Debian / Windows Bash
+
+**Note** If you already have a higher version of python on your system, replace **python3.8** with your installed version bellow
+
+    apt update
+    apt install python3-venv python3.8-dev python3.8-venv git make gcc
+
+Optionally set default `python3`:
+
+    update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.8 1
+
+### Mac OS
+
+    brew install zlib git readline jpeg libpng libyaml
+
+
+## Install
+
+In order to develop Plone 6 backend add-on run:
+
+    git clone https://github.com/eea/eea.facetednavigation
+    cd eea.facetednavigation
+    make
+    make start
+
+To use other **Python** version run make with `-e` parameter:
+
+    make -e PYTHON=python3.8
+    make start
+
+To use other **Plone** version run make with `-e` parameter:
+
+    make -e PLONE_VERSION=5.2.9
+    make start
+
+## CSS / JS Resources
+
+CSS and JS static resources are automatically built on `make start` but you can always manually rebuild them by running:
+
+    yarn
+    yarn build
+
+See the `resources` directory if you need to add or remove CSS/JS resources.
+
+See `webpack.config.js` and `package.json` for the static resources input/output options.
+
+## Develop
+
+Run:
+
+    make develop
+
+We recommend using [Visual Studio Code](https://code.visualstudio.com/) Editor
+* Extensions:
+  * [Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) - Windows only
+  * [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
+* Open Visual Studio Code and click **File > Open Folder**
+* Browser your computer and select **eea.facetednavigation**
+* Within the **Explorer** open `eea > facetednavigaton > interfaces.py` and type
+  `from zope.component import query`. If you get the auto-complete options, you're done.
+* Happy hacking!
+
+**Note** `Hot reload` is not available for Plone backend development, thus you'll have to **restart** Plone after you edit Python code. Still, there are options to reload your changes without restarting Plone, by using `plone.reload` and `dm.plonepatches.reload`. Go to http://localhost:8080/@@reload `admin:admin`
+
+See also: [Debugging Plone in Visual Studio Code](https://community.plone.org/t/our-pip-based-development-workflow-for-plone/14562#debugging-plone-in-visual-studio-code-11)
+
+## Note on Faceted Navigation Javascript events
+
+If you depend on events from Faceted Navigation within your code, make sure you use the correct "depends":
+
+    <records interface="Products.CMFPlone.interfaces.IBundleRegistry"
+             prefix="plone.bundles/your-pkg">
+        <value key="enabled">True</value>
+        <value key="jscompilation">++plone++your-pkg/build/your-pkg-remote.min.js</value>
+        <value key="load_defer">False</value>
+        <value key="load_async">False</value>
+        <value key="depends">faceted.jquery</value>
+    </records>
+
+Now you should be able to execute your code, for example, after the Faceted Navigation (with results - AJAX_QUERY_SUCCESS) has loaded.
+
+      $(window.Faceted.Events).bind(window.Faceted.Events.AJAX_QUERY_SUCCESS, function () {
+        // Your code
+      });
+
+### Useful Visual Studio Code shortcuts
+
+**Note** Replace `Ctrl` with `Cmd` key on MacOS
+
+* **Ctrl+Shift+P** Trim Trailing Whitespace
+* **Ctrl+Shift+P** Sort imports
+* **Ctrl+click** on a `class / import` to go to definition
+
+
+## Testing
+
+You can manually run test in terminal, like:
+
+    bin/zope-testrunner --test-path eea
+
+Or via `Visual Studio Code`
+* Go to `Run > Start Debugging (F5)` and select `Test Plone` debugger.
+
+## Cleanup
+
+If you want to cleanup your development environment and start from scratch just run:
+
+    make clean
+
+## Copyright and license
+
+The Initial Owner of the Original Code is European Environment Agency (EEA).
+All Rights Reserved.
+
+See [LICENSE.md](https://github.com/eea/eea-website-backend/blob/master/LICENSE.md) for details.
+
+## Funding
+
+[European Environment Agency (EU)](http://eea.europa.eu)

eea_facetednavigation-16.5/MANIFEST.in

@@ -0,0 +1,20 @@
+include *.md *.rst *.txt
+graft docs
+graft eea
+global-exclude *pyc
+global-exclude *~
+global-exclude *.un~
+global-include *.mo
+exclude .eslintignore
+exclude .eslintrc.js
+exclude .prettierignore
+exclude .prettierrc.json
+exclude babel.config.js
+exclude docker-compose.yml
+exclude Makefile
+exclude package.json
+exclude webpack.config.js
+exclude yarn.lock
+exclude zope.conf
+prune .vscode
+prune resources