eea.facetednavigation 16.0a1__zip → 16.3__zip

eea.facetednavigation-16.0a1/DEVELOP.md

@@ -1,120 +0,0 @@
-# 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)
-
-### 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)