{"id":20111677,"url":"https://github.com/openstack/ui-cookiecutter","last_synced_at":"2025-07-13T02:09:10.910Z","repository":{"id":45163880,"uuid":"74111109","full_name":"openstack/ui-cookiecutter","owner":"openstack","description":"Cookiecutter template for Horizon Plugin. Mirror of code maintained at opendev.org.","archived":false,"fork":false,"pushed_at":"2023-09-19T14:17:40.000Z","size":245,"stargazers_count":10,"open_issues_count":0,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-09T11:52:55.082Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://opendev.org/openstack/ui-cookiecutter","language":"JavaScript","has_issues":false,"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/openstack.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-18T08:39:42.000Z","updated_at":"2023-10-24T15:32:54.000Z","dependencies_parsed_at":"2022-09-24T20:00:28.542Z","dependency_job_id":null,"html_url":"https://github.com/openstack/ui-cookiecutter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/openstack/ui-cookiecutter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fui-cookiecutter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fui-cookiecutter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fui-cookiecutter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fui-cookiecutter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openstack","download_url":"https://codeload.github.com/openstack/ui-cookiecutter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fui-cookiecutter/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265080256,"owners_count":23708121,"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":[],"created_at":"2024-11-13T18:17:14.205Z","updated_at":"2025-07-13T02:09:10.891Z","avatar_url":"https://github.com/openstack.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"===============\nui-cookiecutter\n===============\n\nCookiecutter template for an OpenStack Dashboard UI plugin project. This\ngenerate UI plugin project using Horizon Angular framework and the generated\nproject includes sample panel with CRUD operations.\n\nSee also https://github.com/audreyr/cookiecutter.\n\n* Free software: Apache license\n* pbr_: Set up to use Python Build Reasonableness\n* hacking_: Enforces the OpenStack Hacking Guidelines\n* eslint_: Enfoces the JavaScript Guidelines\n* testrepository_: Runs tests using testrepository\n* OpenStack-Infra_: Ready for OpenStack Continuous Integration testing\n* Tox_ testing: Setup to easily test for Python 2.7, 3.4\n* karma_ testing: Setup to easily test for JavaScript\n* Sphinx_ docs: Documentation ready for generation and publication\n* reno_ : Sphinx extension for Release Notes\n\nUsage\n-----\n\nGenerate a Python package project::\n\n    cookiecutter https://github.com/openstack/ui-cookiecutter.git\n\nThis command prompts interactive input. Please check these parameters::\n\n* \"repo_group\": The name for the git repo group. e.g. \"openstack\"\n* \"repo_name\": The name for the git repo. e.g. \"cafe-ui\", This is used as python package name too.\n* \"launchpad_project\": The name of the project on launchpad. e.g. \"cafe-ui\",\n* \"project_short_description\": The short descriptions for your UI. e.g. \"Cafe User Interface\",\n* \"help_name\": The name for the help. e.g. \"Cafe-UI\",\n* \"call_by_name\": The name of this UI to write texts such as README or Help. e.g. \"Cafe UI\",\n* \"module_name\": The name of the python module. e.g. \"cafe_ui\"\n* \"dashboard\": The slug of the \"dashboard\" you want to add this plugin into. e.g. \"project\",\n* \"panel_group\": The slug for the \"panel_group\". e.g. \"cafe\",\n* \"panel_group_name\": The caption for the \"panel_group\". e.g. \"Cafe\",\n* \"panel\": The slug of the \"panel\", in singular. e.g. \"drink\",\n* \"panel_func\": The function name for the \"panel\", in singular. e.g. \"Drink\",\n* \"api_module\": The name of the API service module. e.g. \"cafe\",\n* \"api_name\": The caption for the \"api_module\". e.g. \"Cafe\"\n\nIf you want to generate without interactive input, you can use example values for these parameters as follow::\n\n   cookiecutter https://github.com/openstack/ui-cookiecutter.git --no-input\n\nRun with OpenStack Horizon::\n\n    cd \u003crepo_name\u003e\n    pip install\n    cp \u003crepo_name\u003e/\u003cmodule_name\u003e/enabled/_90_project_\u003cpanel_group\u003e_panelgroup.py \u003chorizon-dir\u003e/openstack_dashboard/local/enabled\n    cp \u003crepo_name\u003e/\u003cmodule_name\u003e/enabled/_91_project_\u003cpanel_group\u003e_\u003cpanel\u003es.py \u003chorizon-dir\u003e/openstack_dashboard/local/enabled\n\nthen reboot the Horizon.\n\nOpenStack projects require a working git repo for pbr to work, on newer\nversions of cookiecutter (\u003e= 0.7.0 released 2013-11-09) this inital commit will\nbe done automatically. Otherwise you will need to init a repo and commit to it\nbefore doing anything else::\n\n    cd $repo_name\n    git init\n    git add .\n    git commit -a\n\nThen::\n\n* Add the project to the OpenStack Infrastructure\n\n\n.. _pbr: https://docs.openstack.org/pbr/latest/\n.. _hacking: https://opendev.org/openstack/hacking/raw/branch/master/HACKING.rst\n.. _eslint: http://eslint.org/\n.. _OpenStack-Infra: https://docs.openstack.org/infra/system-config\n.. _testrepository: https://testrepository.readthedocs.org/\n.. _Tox: http://testrun.org/tox/\n.. _karma: https://github.com/karma-runner/karma\n.. _Sphinx: http://sphinx-doc.org/\n.. _reno: https://docs.openstack.org/reno/latest/\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fui-cookiecutter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenstack%2Fui-cookiecutter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fui-cookiecutter/lists"}