{"id":18603006,"url":"https://github.com/ymfe/ykit-config-ssr","last_synced_at":"2025-10-20T00:06:54.688Z","repository":{"id":57403833,"uuid":"107209010","full_name":"YMFE/ykit-config-ssr","owner":"YMFE","description":"ykit + react + react-router-v4 + ssr 插件","archived":false,"fork":false,"pushed_at":"2017-10-27T06:12:00.000Z","size":17,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-16T18:13:22.965Z","etag":null,"topics":["ykit","ykit-plugin"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/YMFE.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-17T02:43:05.000Z","updated_at":"2018-04-14T14:31:24.000Z","dependencies_parsed_at":"2022-09-15T20:01:40.967Z","dependency_job_id":null,"html_url":"https://github.com/YMFE/ykit-config-ssr","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YMFE%2Fykit-config-ssr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YMFE%2Fykit-config-ssr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YMFE%2Fykit-config-ssr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YMFE%2Fykit-config-ssr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/YMFE","download_url":"https://codeload.github.com/YMFE/ykit-config-ssr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254582912,"owners_count":22095519,"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":["ykit","ykit-plugin"],"created_at":"2024-11-07T02:13:12.529Z","updated_at":"2025-10-20T00:06:49.651Z","avatar_url":"https://github.com/YMFE.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ykit-config-ssr\n\nykit + react(16) + react-router(v4) ssr 插件\n\n## 如何开始\n\n可以利用该插件初始化项目，在一个空的目录下执行：\n\n```shell\nykit init ssr\n```\n\n会在当前目录下生成一个初始工程。然后启动项目：\n\n```shell\nykit start\n```\n\n访问 http://localhost:3000/ 即可。\n\n## 如何使用\n\n代码主要分为两部分\n\n### /src —— 业务代码\n\n首先业务需要提供一个 index.js 来配置页面，一个简单的示例：\n\n```JavaScript\nimport 'babel-polyfill';\n\n// 引入页面\nimport Home from './home';\nimport Detail from './detail';\n\n// 引入 axios 来获取数据\nimport axios from 'axios';\n\n// 需要实现一个 getPages 方法来配置页面\nexport function getPages() {\n    return [\n        {\n            path: '/', // 路径规则\n            component: Home, // 页面组件\n            exact: true, // 同 react-router \u003cRoute\u003e 的 exact 属性\n            getProps: async() =\u003e { // 可在这里获取页面需要的数据\n                const { data: posts } = await axios.get(\n                    'http://yapi.demo.qunar.com/mock/818/tvmaze/list'\n                );\n                return { posts };\n            }\n        }, {\n            path: '/detail/:id',\n            component: Detail\n        }\n    ];\n}\n```\n\n通过 `index.js` 封装了页面的各项配置，业务不需要再自己配置 router，只用编写页面组件并从 `index.js` 引入即可。\n\n### /ssr —— 工具生成的服务端代码\n\n业务不需要关心里面有什么，也不需要管理和维护它，由工具自动生成。如果有特殊需求也可以去进行改动。\n\n这样一来，业务不用关心服务端代码，以及 web 和 hy 如何适配，只要根据页面编写业务逻辑即可。同时还可以配置 getProps 来获取初始属性（页面数据等），框架可以智能地提前加载数据来渲染页面（由框架决定是在服务端还是客户端获取数据）。\n\n### 如何实现页面跳转\n\n通过引入 ssr 目录下封装的 `link` 组件(TODO: 这里需要封装到工具里，而不是从路径引)，即可实现页面跳转，使用方法同 react-router v4 中的 `\u003cLink\u003e`。\n\n```JavaScript\nimport Link from '../ssr/share/link';\n\nconst Home = (props) =\u003e {\n    return (\n        \u003cdiv\u003e\n            \u003ch1\u003eHome Page\u003c/h1\u003e\n            \u003cLink to={`/detail`}\u003e\n                \u003cp\u003e点击我可以跳转到详情页\u003c/p\u003e\n            \u003c/Link\u003e\n        \u003c/div\u003e\n    )\n}\n```\n\n## 如何部署\n\n首先构建前端资源：\n\n```\nykit pack -m\n```\n\n然后可以直接使用 pm2 等进行部署，如：\n\n```\nNODE_ENV=production pm2 start ssr/bin/start\n```\n\n## 示例\n\n查看：https://github.com/roscoe054/ykit-starter-ssr\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fymfe%2Fykit-config-ssr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fymfe%2Fykit-config-ssr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fymfe%2Fykit-config-ssr/lists"}