# Static resources for the Euphorie project
This repository contains static resources for the [Euphorie](https://github.com/euphorie/Euphorie) project.
## Updating the package
In order to properly update the package, you will need some development tools to be installed, i.e:
- `git`
- `make`
- `rsync`
- `Ruby`
Updating the site is a three-step process.
1. you need to fetch a fresh clone of the Euphorie prototype.
2. you need to compile the resources.
3. you need to install the resources in the Euphorie package.
This can be done by running the following command:
```bash
make all
```
Run:
```bash
make help
```
to see all available commands and fine tune the build experience.
### Fetching a fresh clone of the Euphorie prototype
To update the repository, run the command:
```bash
make update-proto
```
The clone will be placed in the `var/prototype` directory.
Running `make all` will take care of running this command for you.
### Compiling the resources
The resources are compiled using the static site generator `Jekyll`. The compiled site can be found in the `var/prototype/_site` directory.
To compile the resources, run the command:
```bash
make jekyll
```
This command will also clone (but not update) the Euphorie prototype if it is not already present.
Running `make all` will take care of running this command for you.
### Installing the resources in the Euphorie package
The compiled prototype in `var/prototype/_site` needs to be copied in this package. Only selected resources will be copied and they will end up in the `src/plonestatic/euphorie/resources` directory.
The `resources` directory will be served by `Plone` as a static resource folder under the path `++resource++euphorie.resource`.
While doing the copy, some references to the other resources in CSS and HTML files have to be rewritten to adjust to the new location, e.g. `/assets/...` will be rewritten to `/++resource++euphorie.resource/assets/...`.
The command to install the resources is:
```bash
make resources-install
```
Running `make all` will take care of running this command for you.
## 1.0.0a1 (2025-02-03)
- Initial release
Raw data
{
"_id": null,
"home_page": "https://github.com/euphorie/plonestatic.euphorie",
"name": "plonestatic.euphorie",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "euphorie OiRA Interactive Risk Assessment static resources",
"author": "Syslab.com",
"author_email": "info@syslab.com",
"download_url": "https://files.pythonhosted.org/packages/98/b2/ff3a6e9ac6df62e97a6ea8b6722b8b9e0b783731f5f1bd11d47e26efa650/plonestatic_euphorie-1.0.0a1.tar.gz",
"platform": null,
"description": "# Static resources for the Euphorie project\n\nThis repository contains static resources for the [Euphorie](https://github.com/euphorie/Euphorie) project.\n\n## Updating the package\n\nIn order to properly update the package, you will need some development tools to be installed, i.e:\n\n- `git`\n- `make`\n- `rsync`\n- `Ruby`\n\nUpdating the site is a three-step process.\n\n1. you need to fetch a fresh clone of the Euphorie prototype.\n2. you need to compile the resources.\n3. you need to install the resources in the Euphorie package.\n\nThis can be done by running the following command:\n\n```bash\nmake all\n```\n\nRun:\n\n```bash\nmake help\n```\n\nto see all available commands and fine tune the build experience.\n\n### Fetching a fresh clone of the Euphorie prototype\n\nTo update the repository, run the command:\n\n```bash\nmake update-proto\n```\n\nThe clone will be placed in the `var/prototype` directory.\n\nRunning `make all` will take care of running this command for you.\n\n### Compiling the resources\n\nThe resources are compiled using the static site generator `Jekyll`. The compiled site can be found in the `var/prototype/_site` directory.\n\nTo compile the resources, run the command:\n\n```bash\nmake jekyll\n```\n\nThis command will also clone (but not update) the Euphorie prototype if it is not already present.\n\nRunning `make all` will take care of running this command for you.\n\n### Installing the resources in the Euphorie package\n\nThe compiled prototype in `var/prototype/_site` needs to be copied in this package. Only selected resources will be copied and they will end up in the `src/plonestatic/euphorie/resources` directory.\n\nThe `resources` directory will be served by `Plone` as a static resource folder under the path `++resource++euphorie.resource`.\n\nWhile doing the copy, some references to the other resources in CSS and HTML files have to be rewritten to adjust to the new location, e.g. `/assets/...` will be rewritten to `/++resource++euphorie.resource/assets/...`.\n\nThe command to install the resources is:\n\n```bash\nmake resources-install\n```\n\nRunning `make all` will take care of running this command for you.\n\n## 1.0.0a1 (2025-02-03)\n\n- Initial release\n\n",
"bugtrack_url": null,
"license": "GPL",
"summary": "Euphorie Risk Assessment tool static resources",
"version": "1.0.0a1",
"project_urls": {
"Homepage": "https://github.com/euphorie",
"Issues": "https://github.com/euphorie/plonestatic.euphorie/issues",
"Source": "https://github.com/euphorie/plonestatic.euphorie"
},
"split_keywords": [
"euphorie",
"oira",
"interactive",
"risk",
"assessment",
"static",
"resources"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "98b2ff3a6e9ac6df62e97a6ea8b6722b8b9e0b783731f5f1bd11d47e26efa650",
"md5": "ba7347ee37da9b705782f68d2ea40109",
"sha256": "a3b2d89b02b20d7697c74d34f8294f4ce30912d7e7a0f07502d34d6a0fa5778c"
},
"downloads": -1,
"filename": "plonestatic_euphorie-1.0.0a1.tar.gz",
"has_sig": false,
"md5_digest": "ba7347ee37da9b705782f68d2ea40109",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 9127028,
"upload_time": "2025-02-03T10:28:30",
"upload_time_iso_8601": "2025-02-03T10:28:30.043735Z",
"url": "https://files.pythonhosted.org/packages/98/b2/ff3a6e9ac6df62e97a6ea8b6722b8b9e0b783731f5f1bd11d47e26efa650/plonestatic_euphorie-1.0.0a1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-03 10:28:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "euphorie",
"github_project": "plonestatic.euphorie",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "plonestatic.euphorie"
}
JSON
