{"id":13551936,"url":"https://github.com/etalab/udata-gouvfr","last_synced_at":"2025-04-03T02:32:27.031Z","repository":{"id":16391056,"uuid":"19141770","full_name":"etalab/udata-gouvfr","owner":"etalab","description":"Skin and customization for the French opendata portal based on udata. This project is not maintained anymore. Consider using https://github.com/etalab/udata-front as an alternative.","archived":true,"fork":false,"pushed_at":"2021-09-14T08:27:50.000Z","size":13794,"stargazers_count":25,"open_issues_count":27,"forks_count":33,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-05T13:42:26.382Z","etag":null,"topics":["open-data","open-source","python","udata","udata-gouvfr"],"latest_commit_sha":null,"homepage":"https://www.data.gouv.fr/fr/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/etalab.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-04-25T09:58:14.000Z","updated_at":"2024-10-05T15:19:24.000Z","dependencies_parsed_at":"2022-08-25T12:41:30.663Z","dependency_job_id":null,"html_url":"https://github.com/etalab/udata-gouvfr","commit_stats":null,"previous_names":[],"tags_count":76,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/etalab%2Fudata-gouvfr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/etalab%2Fudata-gouvfr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/etalab%2Fudata-gouvfr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/etalab%2Fudata-gouvfr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/etalab","download_url":"https://codeload.github.com/etalab/udata-gouvfr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246925493,"owners_count":20855890,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["open-data","open-source","python","udata","udata-gouvfr"],"created_at":"2024-08-01T12:01:56.052Z","updated_at":"2025-04-03T02:32:23.283Z","avatar_url":"https://github.com/etalab.png","language":"Python","funding_links":[],"categories":["HTML","open-source"],"sub_categories":[],"readme":"# udata-gouvfr\n\n**Note: This project is not maintained anymore. Consider using [udata-front](https://github.com/etalab/udata-front) as an alternative.**\n\nudata customizations for Etalab / Data.gouv.fr.\n\n## Compatibility\n\n**udata-gouvfr** requires Python 3.7+ and [udata][].\n\n\n## Installation\n\nInstall [udata][].\n\nRemain in the same Python virtual environment\nand install **udata-gouvfr**:\n\n```shell\npip install udata-gouvfr\n```\n\nCreate a local configuration file `udata.cfg` in your **udata** directory\n(or where your UDATA_SETTINGS point out) or modify an existing one as following:\n\n```python\nPLUGINS = ['gouvfr']\nTHEME = 'gouvfr'\n```\n\n## Development\n\nPrepare a [udata development environment][udata-develop].\n\nNote that we're using [pip-tools][udata-deps] on this repository too.\n\nIt is recommended to have a workspace with the following layout:\n\n```shell\n$WORKSPACE\n├── fs\n├── udata\n│   ├── ...\n│   └── setup.py\n├── udata-gouvfr\n│   ├── ...\n│   └── setup.py\n└── udata.cfg\n```\n\nThe following steps use the same Python virtual environment\nand the same version of npm (for JS) as `udata`.\n\nClone the `udata-gouvfr` repository into your workspace\nand install it in development mode:\n\n```shell\ngit clone https://github.com/etalab/udata-gouvfr.git\ncd udata-gouvfr\npre-commit install\npip install -e . -r requirements/test.pip -r requirements/develop.pip\n```\n\n\u003e NB: the `udata.(in|pip)` files are used by the CI to stay in sync with `udata` requirements. You shouldn't need to tinker with them on your local environment, but they might be updated by the CI when you make a Pull Request.\n\nModify your local `udata.cfg` configuration file as following:\n\n```python\nPLUGINS = ['gouvfr']\nTHEME = 'gouvfr'\n```\n\nYou can execute `udata-gouvfr` specific tasks from the `udata-gouvfr` directory.\n\n**ex:** Build the assets:\n\n```shell\ncd udata-gouvfr\nnpm install\ninv assets-build\n```\n\nYou can list available development commands with:\n\n```shell\ninv -l\n```\n\n\n## Theme\n\nThe front-end theme for the public facing website, is split into two parts :\n- The [Jinja](https://jinja.palletsprojects.com/en/2.11.x/) templates are located inside `udata_gouvfr/theme/templates`.\n- The [Less](http://lesscss.org/) \u0026 other sourcefiles for the are located in `theme`.\n\nIn addition we have a nice litle set of CSS Utilities to quickly build front end components, inspired by bootstrap, most of its documentation\nlives in the css located in `theme/less/` and is built using [Stylemark](https://github.com/mpetrovich/stylemark), you can read the live documentation\nin `udata_gouvfr/theme/stylemark/` after building it using `npm run build-stylemark`.\n\nWhen building pages, here are a few templates to look out for in `udata_gouvfr/theme/templates` :\n- `home.html` : well, duh.\n- `header.html` and `footer.html` : same idea.\n- `raw.html` : contains the general html structure exposing a `body` block where we can write our page's body.\n- `base.html` : contains some extra html structure exposing a `content` block for our page's content.\n- `subnav-large.html`, `publish-action-modal.html` and `carousel.html` : **TODO**\n\nHere are our reusable components :\n- `dataset` : datasets listings used in many pages.\n- `reuse` : cards for displaying dataset reused in the real world.\n- `participez` : is the large blue callout seen on multiple pages.\n- `macros` : **TODO**\n- `svg` : contains SVG assets to be included in our pages.\n\n### TODO\nFront docs todo :\n- Parcel 2 architecture\n  - Static copy\n  - Stylemark build\n  - VueJS compiler mode\n- VanillaJS IIFE architecture\n- Vue 3 architecture\n  - Modals\n  - I18n\n  - Config plugin\n  - Components\nBack docs todo :\n- CSS/JS file inclusion\n- Static route for UI-Kit\n\nWhenever a components needs some special styling, you can find their corresponding definitions inside `theme/less/specific/\u003ccomponent\u003e`,\nit's best if we can avoid having too much specific styling, but sometimes you just really need it.\n\nFinally, we have a bunch of commands to make your life a tad easier, that you can run through `npm run`.\n- `build`: Builds the final CSS/JS files and the UI-Kit Documentation. You should probably use this one.\n- `build:app`: Builds the final CSS/JS files without the UI-Kit\n- `build:stylemark`: Builds the UI-Kit files and also the CSS/JS files but unminifed (do not use those static files in production)\n- `i18n:report`: Generates a report of the i18n missing and unused keys\n- `i18n:extract`: Same as above, but also automatically adds missing keys to translation files\n- `clean`: Cleans Parcel cache. Use this if you stumble upon weird bugs to start anew.\n- `start`: Get to coding with live reload and things\n\n[udata]: https://github.com/opendatateam/udata\n[udata-doc]: http://udata.readthedocs.io/en/stable/\n[udata-develop]: http://udata.readthedocs.io/en/stable/development-environment/\n[udata-deps]: https://udata.readthedocs.io/en/stable/development-environment/#dependency-management\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fetalab%2Fudata-gouvfr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fetalab%2Fudata-gouvfr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fetalab%2Fudata-gouvfr/lists"}