{"id":19178031,"url":"https://github.com/uteamjs/uteam-template","last_synced_at":"2026-04-13T03:49:19.182Z","repository":{"id":57092598,"uuid":"421752315","full_name":"uteamjs/uteam-template","owner":"uteamjs","description":"Template for creation and generation of @uteamjs/react and   @uteamjs/node application","archived":false,"fork":false,"pushed_at":"2022-06-15T04:52:24.000Z","size":66,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-04T08:42:53.382Z","etag":null,"topics":["javascript","react","react-router","redux","template","yaml"],"latest_commit_sha":null,"homepage":"https://u.team","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/uteamjs.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2021-10-27T09:17:48.000Z","updated_at":"2021-11-14T14:16:53.000Z","dependencies_parsed_at":"2022-08-22T21:40:24.139Z","dependency_job_id":null,"html_url":"https://github.com/uteamjs/uteam-template","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uteamjs%2Futeam-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uteamjs%2Futeam-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uteamjs%2Futeam-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uteamjs%2Futeam-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/uteamjs","download_url":"https://codeload.github.com/uteamjs/uteam-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240254906,"owners_count":19772506,"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":["javascript","react","react-router","redux","template","yaml"],"created_at":"2024-11-09T10:36:17.148Z","updated_at":"2026-04-13T03:49:19.137Z","avatar_url":"https://github.com/uteamjs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[@uteamjs/template](https://u.team/document/template) bootstrap the creation of **React-Redux** \u0026 __Node.js__ application and packages by providing the following templates:\n- React \u0026 Node.js Application template for use in [uteam create application](https://u.team/document/cli#create)\n- React Package template for use in [uteam create packages](https://u.team/document/cli#create)\n- Example templates for use in [Tutorial section](https://u.team/document/tutorial/helloworld)\n- Individual file template for [YAML uteam generation](https://u.team/document/yaml/overview#uteam-generate)\n\n# Installation\n**@uteamjs/template** is installed under the [uteam cli](https://u.team/document/cli) __node_modules__ folder.  Install the __uteam cli__ automatically install the template.\n```\n$ npm install -g uteam\n```\n\n# React Template\n## react-application\nDefault application template for using in __uteam create application__. Run the following command to create [@uteamjs/react](https://u.team/document/uteam-react/overview) application:\n```\n$ uteam create --application \u003capplication name\u003e\n```\nThe following directory will be created under your \u003cproject_folder\u003e:\n```\n./\u003capplication name\u003e/\n    node_modules/\n        @uteamjs/react  \n        \u003creact, redux, react-router... etc\u003e\n\n    packages/\n        main/\n            config/\n            ...\n            src/\n                index.js\n            package.json\n\n    package.json\n```\n__packages/main__ is the only package bundled with the application created which is the entry point of the application.   \n\nThe __index.js__ is the layout container with:\n- Top logo and menu bar.\n- Responsive side tree menu .\n- Toastify messages.\n## react-packages\nDefault package template for adding your customer modules.  Run the following command to create single or multiple packages:\n```\n$ uteam create --packages \u003cpackages name1\u003e \u003cpackages name2\u003e --generate\n```\nNote: --generate automatically run [uteam generate](https://u.team/document/cli#generate) to create the JSX files.\n\nChange to __...packages/main__ folder, then start the webpack development server:\n```\n$ npm start\n```\nOpen your browser with URL http://localhost:3000, then click the __Get Started__ link:\n\n![Get Started](https://u.team/assets/img/kix.sznz2xcqhgjb.png)\n\nEach item on the top menu bar represents one package.  \n\nEach package has its own tree menu which can be customized through the [app.yaml file](https://u.team/document/yaml/appyaml). \n## react-redux\nThere are four template files used for YAML generation of JSX code:\n\n- **modules.js** - An index file for exporting all the components in the package.\n```jsx\nimport { lazy } from 'react'\n \n/*route*/\n/*popRoute*/\n```\nNote: The /* … */ comment statements are insertion points for code generation. Please do not delete or change the statement.\n\nWhen exports switch enabled in YAML, the following pair of files are being used:\n- **init.js** - File for user to insert custom code.\n- **exports.js** - File for generation of _reducer object and _layout class to be exported.\n\nOtherwise use the following file:\n__page.js__ - File for creating single page components.\n\n# Node.js Template\n## node-application\nDefault application template for creating [@uteamjs/node](https://u.team/document/uteam-node/overview) application.  Run the following command to create application:\n```\n$ uteam create -a \u003capplication name\u003e -t node-application\n```\nThe follow folders are created:\n```\n/\u003cproject_folder\u003e/tutorial-node/\n    ...\n    packages/\n        main/\n            config.json\n            package.json\n            server.js\n```\nThe __server.js__ is the main entry point of the server application.   Change to __...packages/main__ folder, then start the server using command:\n```\n$ node server\n```\nTo build server packages, you can just add [Restful API](https://u.team/document/uteam-node/api) component.js files under each package folder.\n```\n/\u003cproject_folder\u003e/tutorial-node/\n    ...\n    packages/\n        main/\n        \u003cpackage 1\u003e\n            \u003ccomponent 1\u003e.js\n            \u003ccomponent 2\u003e.js\n```\n\n# Examples Template\n## yaml-examples\nBatch of examples to illustrate __YAML code generation__. Run the follow command to add to your application:\n```\n$ uteam create -p yaml-examples -t yaml-examples -g\n```\nNote: The package name must be yaml-examples otherwise some broken link may appear.\n\n![YAML Examples](https://u.team/assets/img/kix.k452tyxghxfs.png)\n\n## yaml-crud \nA full example with the following features:\n- Complete CRUD operation with minimal JSX code\n- Support co-exist of YAML and JSX code\n- Add-on JSX code will not be overwritten in re-generation\n\nPlease refer to the [YAML CRUD tutorial](https://u.team/document/tutorial/crud) for a full explanation.\n\nRun the follow command to add **yaml-crud** package to your application:\n```\n$ uteam create -p crud -t yaml-crud -g\n```\n![CRUD](https://u.team/assets/img/kix.tbr16n77h14y.png)\n## yaml-crud-api\nSimilar to the yaml-crud except the CRUD action will be fetched to the backend API server. \n\n![CRUD api](https://u.team/assets/img/kix.z7pqrddqn169.png)\n\nFor frontend package, run the following command to add **crud-api** package to your application:\n```\n$ uteam create -p crud-api -t yaml-crud-api -g\n```\n## node-crud-api\nBackend package to handle CRUD requests from the yaml-crud-api frontend. Run the following command UNDER the @uteamjs/node application created above:\n```\n$ uteam create -p crud-api -t node-crud-api\n```\nNote: **--generation** option is not required for backend application.\n\nPlease refer to the [CRUD API tutorial](https://u.team/document/tutorial/crudapi) for a full explanation.\n\n# Template Update\nSince the **@uteamjs/template** is installed in the npm global folder, it is hard to locate the directory for updating.  The update process is executed through the **uteam cli** as follows:\n```\n$ uteam template --update\n```\nNote: **npm update -g uteam** may be update the **@uteamjs/template**.\n\n# License\n[MIT](LICENSE)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Futeamjs%2Futeam-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Futeamjs%2Futeam-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Futeamjs%2Futeam-template/lists"}