data.gouv.fr的数据udata定制
项目描述
udata-gouvfr
Etalab / Data.gouv.fr的udata定制。
注意: 这是一个udata扩展,您应首先阅读udata文档。
兼容性
udata-gouvfr需要Python 3.7+和udata。
安装
安装udata。
保持在同一Python虚拟环境中,并安装udata-gouvfr
pip install udata-gouvfr
在您的udata目录中创建一个本地配置文件udata.cfg
(或UDATA_SETTINGS指向的位置)或按以下方式修改现有的一个
PLUGINS = ['gouvfr']
THEME = 'gouvfr'
开发
准备一个udata开发环境。
注意,我们在本存储库中也使用pip-tools。
建议您有一个具有以下布局的工作区
$WORKSPACE
├── fs
├── udata
│ ├── ...
│ └── setup.py
├── udata-gouvfr
│ ├── ...
│ └── setup.py
└── udata.cfg
以下步骤使用与 udata
相同的 Python 虚拟环境和相同的 npm(用于 JS)版本。
将 udata-gouvfr
仓库克隆到您的工位,并以开发模式安装。
git clone https://github.com/etalab/udata-gouvfr.git
cd udata-gouvfr
pre-commit install
pip install -e . -r requirements/test.pip -r requirements/develop.pip
注意:
udata.(in|pip)
文件由 CI 使用,以保持与udata
的需求同步。您不需要在自己的本地环境中对其进行调整,但在您发起拉取请求时,CI 可能会更新它们。
按照以下方式修改您的本地 udata.cfg
配置文件。
PLUGINS = ['gouvfr']
THEME = 'gouvfr'
您可以从 udata-gouvfr
目录执行 udata-gouvfr
特定的任务。
例如:构建资源。
cd udata-gouvfr
npm install
inv assets-build
您可以使用以下命令列出可用的开发命令。
inv -l
主题
面向公众网站的前端主题分为两个部分
此外,我们还有一组精美的 CSS 工具类,用于快速构建前端组件,灵感来自 bootstrap,大部分文档位于 theme/less/
中的 css,并使用 Stylemark 构建,您可以使用 npm run build-stylemark
命令构建后,在 udata_gouvfr/theme/stylemark/
中阅读实时文档。
在构建页面时,请关注以下位于 udata_gouvfr/theme/templates
中的模板
home.html
: 好吧,不言而喻。header.html
和footer.html
: 同样的想法。raw.html
: 包含通用 HTML 结构,其中包含一个body
块,我们可以在此处编写页面的主体。base.html
: 包含一些额外的 HTML 结构,其中包含一个content
块,用于页面的内容。subnav-large.html
、publish-action-modal.html
和carousel.html
: 待办
以下是我们的可重用组件
dataset
: 许多页面中使用的数据集列表。reuse
: 用于显示在现实世界中复用的数据集的卡片。participez
: 是在多个页面上看到的大蓝色呼吁。macros
: 待办svg
: 包含要包含在页面中的 SVG 资产。
待办事项
前端文档待办事项
- Parcel 2 架构
- 静态副本
- Stylemark 构建
- VueJS 编译器模式
- VanillaJS IIFE 架构
- Vue 3 架构
- 模态框
- I18n
- 配置插件
- 组件后端文档待办事项
- CSS/JS 文件包含
- UI-Kit 的静态路由
当组件需要一些特殊样式时,您可以在 theme/less/specific/<component>
中找到它们相应的定义,最好尽量避免过多的特殊样式,但有时您真的需要它们。
最后,我们有一系列命令可以使您的生活更加轻松,您可以通过 npm run
命令运行它们。
build
:构建最终的 CSS/JS 文件和 UI-Kit 文档。您可能需要使用此命令。build:app
:构建最终的 CSS/JS 文件,但不包含 UI-Kitbuild:stylemark
:构建 UI-Kit 文件,并且也构建了 CSS/JS 文件,但未压缩(请勿在生产环境中使用这些静态文件)i18n:report
:生成 i18n 缺失和未使用密钥的报告i18n:extract
:与上面相同,但还会自动将缺失密钥添加到翻译文件中clean
:清除 Parcel 缓存。如果遇到奇怪的错误,请使用此命令重新开始。start
:使用实时重新加载等功能开始编码
变更日志
3.1.0 (2021-08-31)
3.0.7 (2021-08-17)
- 更新crowdin翻译#622
3.0.6 (2021-08-16)
3.0.5 (2021-08-12)
- 在geo.data.gouv.fr的数据集中添加横幅#607
3.0.4 (2021-08-12)
- 在资源描述中用markdown替换mdstrip过滤器#606
- 修复多个响应式问题并防止VueJS在编译错误时崩溃页面#605
- 用新的卫生COVID-19库存按钮替换旧的库存按钮#608
- 将SPD数据集添加到主页#609
- 从数据集页面上删除重复的参与块#611
- 在提交建议搜索时添加数据集的重定向#612
3.0.3 (2021-07-30)
3.0.2 (2021-07-19)
3.0.1 (2021-07-09)
3.0.0 (2021-07-07)
- :warning: 重大变更:大多数主题/模板逻辑已从https://github.com/opendatateam/udata移动到此存储库。
udata
不再包含默认主题。在3.x系列中,我们希望它可以用作“无头”开放数据平台,但现在您可能需要连接自己的主题或使用udata-gouvfr。 更多关于此更改的信息。 #492
2.6.2 (2021-05-25)
- 新翻译#535
2.6.1 (2021-05-25)
- 添加新翻译#518
2.6.0 (2021-05-25)
- [maaf]修复编码问题#531
- 添加支持页面链接#532
- UX增强#525
- 移除英雄背景图片。
- 移除主页的轮播图。
- 更改主页布局。数据集现在在顶部,然后是再利用。
- 将“个人资料”重命名为“公共个人资料”
2.5.5 (2021-04-02)
- 感谢所有的鱼#529
2.5.4 (2021-03-31)
- 🦀
2.5.3 (2021-03-23)
- 在CircleCI的发布步骤中添加venv激活#526
2.5.2 (2021-03-22)
2.5.1 (2021-01-26)
- 新增Crowdin翻译 #511
2.5.0 (2021-01-25)
2.3.0 (2020-11-30)
- 主题上的只读模式修改 #509
- 在前端视图中显示警告横幅。
- 隐藏贡献者主页的模态。
- 在数据集视图中隐藏重用创建卡片和社区资源创建卡片。
- 新闻通讯订阅横幅 #512
- 覆盖帖子列表模板中的警报部分以显示新闻通讯订阅横幅。
- 添加设置
POST_BANNER_ACTIVATED
以切换横幅的激活。 - 添加设置
POST_BANNER_LINK
和POST_BANNER_MESSAGE
以配置订阅的链接和消息。
2.2.3 (2020-11-09)
- 在帖子列表中添加新闻链接 #504
2.2.2 (2020-10-16)
- 固定udata版本以修复传递请求依赖项 #500
2.2.1 (2020-10-16)
- 横幅现在是通用的并可配置的 #499
- 修复静态页面中的链接
2.2.0 (2020-08-25)
- 在数据集页面上显示 api.gouv.fr API #493
2.1.5 (2020-08-05)
2.1.4 (2020-06-29)
- 从GitHub仓库中的md添加静态/pages/* #483
2.1.3 (2020-06-16)
- 修复打包
2.1.1 (2020-06-11)
- 添加带有从udata设置继承的设置的横幅 #480
2.1.0 (2020-05-13)
- 删除公共服务指标 #472
2.0.2 (2020-04-22)
- 添加“搜索”标志以激活搜索实验小部件 #466
2.0.1 (2020-03-24)
- 为数据集和重用添加covid-19徽章 #473
2.0.0 (2020-03-11)
- 迁移到python3 🐍 #453
1.6.13 (2019-12-13)
1.6.12 (2019-09-11)
1.6.11 (2019-07-11)
- 新的社交logo (
og:image
) #419
1.6.10 (2019-06-26)
1.6.9 (2019-06-07)
1.6.8 (2019-05-29)
1.6.7 (2019-05-23)
1.6.6 (2019-05-20)
1.6.5 (2019-05-10)
1.6.4 (2019-03-27)
- 更新主题入口页面#382
1.6.3 (2019-03-06)
1.6.2 (2018-11-17)
- Konami代码 🥚 #362 注意:这不仅仅是一个值得安装的发布版本,除非是在data.gouv.fr上。
1.6.1 (2018-11-05)
1.6.0 (2018-10-02)
1.4.4 (2018-08-27)
- 修复多搜索标签位置#330
1.4.3 (2018-08-08)
- 修复导航栏切换按钮位置 🎊 #327
1.4.2 (2018-07-30)
- 在页面关于SPD添加引用#318
1.4.1 (2018-06-06)
- 修复打包
1.4.0 (2018-06-06)
- 相关样式资源#265
- 当resource.filetype为文件时强制执行域名白名单(迁移)#292
- 使用新的pypi.org链接#295
- 确保活跃用户有confirmed_at日期(迁移)#298
- 移除致谢页面#306
- 修复
modal-lg
宽度#311 - 添加跟踪和隐私页面#310
1.3.2 (2018-03-28)
1.3.1 (2018-03-15)
- 修复一些卡片位置
1.3.0 (2018-03-13)
- 使用udata pytest插件 #254
- 公开新的入口点。插件和主题翻译现在已拆分#263
- 对卡片组件设计进行对齐#252 #272
- 捕获Discourse超时和响应解析错误#267
- 在主页上的行动呼吁添加跟踪#271
- 在轮播元素上添加跟踪#268
- 临时轮播布局#274
- 添加数据集推荐跟踪#277
1.2.5 (2018-02-05)
- 与opendatateam/udata#1410相关的搜索方面的小修复 #255
1.2.4 (2018-01-24)
- 许可证:更新SHOM附件 + 修复BAN URL #249
1.2.3 (2018-01-17)
1.2.2 (2017-12-14)
- 导出CSS下拉行为到
udata
#234 - 移除内部FAQ并切换到 doc.data.gouv.fr #236
1.2.1 (2017-12-06)
- 导出社区资源头像样式到udata #233
- 丢弃
terms.html
模板。条款和条件现在已外部化并使用udata核心模板。(见 udata#1285)#232
1.2.0 (2017-10-20)
- 使用uData的新搜索蓝图 #224
1.1.2 (2017-09-04)
1.1.1 (2017-07-31)
- 更新了翻译
1.1.0 (2017-07-05)
- 使用基于入口点的主题管理 #164
- 调整数据集重用标题的溢出以正确显示 #172
- 丢弃glyphicons,移除一些无用的类并升级到bootstrap 3.3.7 #177
- 使用核心发布动作窗口 #178
- 修复deuil标题不是SVG的问题 #180
- 集成GeoZones和GeoLogos的最新版本以处理地区。特别是使用GeoHisto中的城镇、县和地区的历史。#499
- 添加缺失的占位符 #194
- 使用
udata.harvesters
入口点 #195 - 改进可操作标签 #189
- 移除
.btn-more
类 #191
1.0.9 (2017-06-28)
- 尚未有任何内容
1.0.8 (2017-06-21)
- 修复了一个错误 #182
1.0.7 (2017-06-20)
- 添加了许可证页面 #181
1.0.6 (2017-04-18)
1.0.5 (2017-04-06)
- 添加了一个缺失的翻译
- SPD数据集的字母顺序排列
1.0.4 (2017-04-05)
- 引入SPD页面和徽章
1.0.3 (2017-02-27)
- 翻译更新
- 将
udata-js
链接切换到metaclic
#161
1.0.2 (2017-02-21)
1.0.1 (2017-02-20)
1.0.0 (2017-02-16)
- 删除一些主菜单条目(事件、CADA、Etalab)
- 使用新的SVG徽标
- 应用来自uData 1.0.0的更改
0.9.1 (2017-01-10)
- 首次发布版本