{"id":20670475,"url":"https://github.com/caicloud/web-template-project","last_synced_at":"2025-04-19T18:23:53.159Z","repository":{"id":54908098,"uuid":"207480066","full_name":"caicloud/web-template-project","owner":"caicloud","description":"A template for starting new web project at Caicloud","archived":false,"fork":false,"pushed_at":"2021-01-21T12:10:41.000Z","size":227,"stargazers_count":3,"open_issues_count":3,"forks_count":14,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-29T11:34:43.891Z","etag":null,"topics":["engineering","template","typescript","web"],"latest_commit_sha":null,"homepage":null,"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/caicloud.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2019-09-10T06:19:22.000Z","updated_at":"2021-03-26T00:18:38.000Z","dependencies_parsed_at":"2022-08-14T06:20:28.357Z","dependency_job_id":null,"html_url":"https://github.com/caicloud/web-template-project","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":"caicloud/common-template-project","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caicloud%2Fweb-template-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caicloud%2Fweb-template-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caicloud%2Fweb-template-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caicloud%2Fweb-template-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/caicloud","download_url":"https://codeload.github.com/caicloud/web-template-project/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249762269,"owners_count":21321903,"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":["engineering","template","typescript","web"],"created_at":"2024-11-16T20:20:45.689Z","updated_at":"2025-04-19T18:23:53.143Z","avatar_url":"https://github.com/caicloud.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\n**Table of Contents** _generated with [DocToc](https://github.com/thlorenz/doctoc)_\n\n- [Common Template Project](#common-template-project)\n  - [About the project](#about-the-project)\n  - [See also](#see-also)\n  - [TODO](#todo)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n# Web Template Project\n\n## About the project\n\nThe Web Template Project is a template for starting new web projects at Caicloud.\n\nThis Template\n\n- is a SPA with React and Node.js Project using TypeScript\n- uses Less as preprocessor\n- testing with Jest and Enzyme\n- uses webpack as module bundler\n\n## Status\n\nThe template project is in alpha status.\n\n### TODO\n\n- lint\n- git hooks\n- tests\n\n## See also\n\n- [nirvana project template](https://github.com/caicloud/nirvana-template-project)\n- [python project template](https://github.com/caicloud/python-template-project)\n- [golang project template](https://github.com/caicloud/golang-template-project)\n\n## Getting started\n\n### Install\n\n```bash\nyarn\n```\n\n### Run dev-server\n\n```bash\nyarn watch\n```\n\nBy default, webpack-dev-server listens to the `m12n.port` in `package.json`\n\n### Build image\n\nTBD.\n\n### Run container\n\n```bash\ndocker run -p \u003cport\u003e:3000 cargo.dev.caicloud.xyz/release/x-web:\u003cVERSION\u003e \n```\n\n`port` MUST be one of endpoint-ports of modularize-web. \n\n### Layout\n\n```\n├── .github\n│   ├── ISSUE_TEMPLATE.md\n│   └── PULL_REQUEST_TEMPLATE.md\n├── .gitignore\n├── CHANGELOG.md\n├── Makefile\n├── OWNERS\n├── README.md\n├── build\n│   └── x-web\n│       └── Dockerfile\n├── docs\n├── package.json\n├── release\n│   └── x-web.yaml\n├── client\n│   ├── components\n│   ├── menus\n│   └── routes\n├── server\n├── scripts\n│   └── read_cpus_available.sh\n└── yarn.lock\n```\n\nA brief description of the layout:\n\n- `.github` has two template files for creating PR and issue. Please see the files for more details.\n- `.gitignore` varies per project, but all projects need to ignore node_modules directory.\n- `CHANGELOG.md` contains auto-generated changelog information.\n- `Makefile` is used to build the project. You need to tweak the variables based on your project.\n- `OWNERS` contains owners of the project.\n- `README.md` is a detailed description of the project.\n- `build` contains scripts, yaml files, dockerfiles, etc, to build and package the project.\n- `docs` for project documentations.\n- `release` [chart](https://github.com/caicloud/charts) for production deployment.\n- `scripts` shell scripts for extra works\n- `client` for client side codes.\n- `server` for server side codes, if any.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaicloud%2Fweb-template-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcaicloud%2Fweb-template-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaicloud%2Fweb-template-project/lists"}