Instructions
============
`简体中文 <./README.zh_CN.rst>`__\ \| English
**Table of contents**
- `Instructions <#instructions>`__
- `Resources <#resources>`__
- `Prerequisites <#prerequisites>`__
- `Local Environment <#local-environment>`__
- `Usage <#usage>`__
- `Docs <#docs>`__
- `How to develop <#how-to-develop>`__
- `How to test <#how-to-test>`__
Resources
---------
- `Wiki <https://wiki.openstack.org/wiki/Skyline>`__
- `Bug Tracker <https://launchpad.net/skyline-console>`__
Prerequisites
-------------
- ``node``: lts/erbium (v12.*)
- ``yarn``: 1.22.4 +
Local Environment
-----------------
Take CentOS as an example
- Install nvm ( version control system for nodejs )
.. code:: shell
wget -P /root/ --tries=10 --retry-connrefused --waitretry=60 --no-dns-cache --no-cache https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh
bash /root/install.sh
. /root/.nvm/nvm.sh
- Install nodejs
.. code:: shell
NODE_VERSION=erbium
nvm install --lts=$NODE_VERSION
nvm alias default lts/$NODE_VERSION
nvm use default
- Verify nodejs and npm versions
.. code:: shell
node -v
# v12.*.*
npm -v
# 6.*.*
- Install yarn
.. code:: shell
npm install -g yarn
- Install the project dependency under the root directory, with
``package.json`` in the same place.
.. code:: shell
yarn install
After those steps, please just wait until the installation is
complete.
Usage
-----
Under the root directory, with ``package.json`` in the same place.
- ``yarn run mock``: Use the mock interface of
`rap2 <http://rap2.taobao.org/>`__
- ``yarn run dev``: To use the actual interface, you can copy
``config/config.yaml`` to ``config/local_config.yaml`` , and
replace the ``server`` value with the correct address.
- ``yarn run build``: Build packages and then you can hand over the
contents of the generated *dist* directory to the back end.
Docs
----
How to develop
~~~~~~~~~~~~~~
- `Preparation before
development <docs/en/develop/1-ready-to-work.md>`__
- `Directory structure <docs/en/develop/2-catalog-introduction.md>`__
- `Develop a new resource
page <docs/en/develop/3-0-how-to-develop.md>`__
- `BaseList
introduction <docs/en/develop/3-1-BaseList-introduction.md>`__
- `BaseTabList
introduction <docs/en/develop/3-2-BaseTabList-introduction.md>`__
- `BaseDetail
introduction <docs/en/develop/3-3-BaseDetail-introduction.md>`__
- `BaseDetailInfo
introduction <docs/en/develop/3-4-BaseDetailInfo-introduction.md>`__
- `BaseStore
introduction <docs/en/develop/3-5-BaseStore-introduction.md>`__
- `FormAction
introduction <docs/en/develop/3-6-FormAction-introduction.md>`__
- `ModalAction
introduction <docs/en/develop/3-7-ModalAction-introduction.md>`__
- `ConfirmAction
introduction <docs/en/develop/3-8-ConfirmAction-introduction.md>`__
- `StepAction
introduction <docs/en/develop/3-9-StepAction-introduction.md>`__
- `FormItem
introduction <docs/en/develop/3-10-FormItem-introduction.md>`__
- `Action introduction <docs/en/develop/3-11-Action-introduction.md>`__
- `Menu introduction <docs/en/develop/3-12-Menu-introduction.md>`__
- `Route introduction <docs/en/develop/3-13-Route-introduction.md>`__
- `I18n introduction <docs/en/develop/3-14-I18n-introduction.md>`__
How to test
~~~~~~~~~~~
- `Two kinds of tests <docs/en/test/1-ready-to-work.md>`__
- `Directory structure <docs/en/test/2-catalog-introduction.md>`__
- `How to edit e2e case <docs/en/test/3-0-how-to-edit-e2e-case.md>`__
- `E2E - Form operation <docs/en/test/3-1-E2E-form-operation.md>`__
- `E2E - Table operation <docs/en/test/3-2-E2E-table-operation.md>`__
- `E2E - Detail operation <docs/en/test/3-3-E2E-detail-operation.md>`__
- `E2E - Resource
operation <docs/en/test/3-4-E2E-resource-operation.md>`__
Raw data
{
"_id": null,
"home_page": "https://docs.openstack.org/skyline-console/latest/",
"name": "skyline-console",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "OpenStack",
"author_email": "openstack-discuss@lists.openstack.org",
"download_url": null,
"platform": null,
"description": "Instructions\n============\n\n`\u7b80\u4f53\u4e2d\u6587 <./README.zh_CN.rst>`__\\ \\| English\n\n**Table of contents**\n\n- `Instructions <#instructions>`__\n\n - `Resources <#resources>`__\n - `Prerequisites <#prerequisites>`__\n - `Local Environment <#local-environment>`__\n - `Usage <#usage>`__\n - `Docs <#docs>`__\n\n - `How to develop <#how-to-develop>`__\n - `How to test <#how-to-test>`__\n\nResources\n---------\n\n- `Wiki <https://wiki.openstack.org/wiki/Skyline>`__\n- `Bug Tracker <https://launchpad.net/skyline-console>`__\n\nPrerequisites\n-------------\n\n- ``node``: lts/erbium (v12.*)\n- ``yarn``: 1.22.4 +\n\nLocal Environment\n-----------------\n\nTake CentOS as an example\n\n- Install nvm ( version control system for nodejs )\n\n .. code:: shell\n\n wget -P /root/ --tries=10 --retry-connrefused --waitretry=60 --no-dns-cache --no-cache https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh\n bash /root/install.sh\n . /root/.nvm/nvm.sh\n\n- Install nodejs\n\n .. code:: shell\n\n NODE_VERSION=erbium\n nvm install --lts=$NODE_VERSION\n nvm alias default lts/$NODE_VERSION\n nvm use default\n\n- Verify nodejs and npm versions\n\n .. code:: shell\n\n node -v\n # v12.*.*\n npm -v\n # 6.*.*\n\n- Install yarn\n\n .. code:: shell\n\n npm install -g yarn\n\n- Install the project dependency under the root directory, with\n ``package.json`` in the same place.\n\n .. code:: shell\n\n yarn install\n\n After those steps, please just wait until the installation is\n complete.\n\nUsage\n-----\n\nUnder the root directory, with ``package.json`` in the same place.\n\n- ``yarn run mock``: Use the mock interface of\n `rap2 <http://rap2.taobao.org/>`__\n- ``yarn run dev``: To use the actual interface, you can copy\n ``config/config.yaml`` to ``config/local_config.yaml`` , and\n replace the ``server`` value with the correct address.\n- ``yarn run build``: Build packages and then you can hand over the\n contents of the generated *dist* directory to the back end.\n\nDocs\n----\n\nHow to develop\n~~~~~~~~~~~~~~\n\n- `Preparation before\n development <docs/en/develop/1-ready-to-work.md>`__\n- `Directory structure <docs/en/develop/2-catalog-introduction.md>`__\n- `Develop a new resource\n page <docs/en/develop/3-0-how-to-develop.md>`__\n- `BaseList\n introduction <docs/en/develop/3-1-BaseList-introduction.md>`__\n- `BaseTabList\n introduction <docs/en/develop/3-2-BaseTabList-introduction.md>`__\n- `BaseDetail\n introduction <docs/en/develop/3-3-BaseDetail-introduction.md>`__\n- `BaseDetailInfo\n introduction <docs/en/develop/3-4-BaseDetailInfo-introduction.md>`__\n- `BaseStore\n introduction <docs/en/develop/3-5-BaseStore-introduction.md>`__\n- `FormAction\n introduction <docs/en/develop/3-6-FormAction-introduction.md>`__\n- `ModalAction\n introduction <docs/en/develop/3-7-ModalAction-introduction.md>`__\n- `ConfirmAction\n introduction <docs/en/develop/3-8-ConfirmAction-introduction.md>`__\n- `StepAction\n introduction <docs/en/develop/3-9-StepAction-introduction.md>`__\n- `FormItem\n introduction <docs/en/develop/3-10-FormItem-introduction.md>`__\n- `Action introduction <docs/en/develop/3-11-Action-introduction.md>`__\n- `Menu introduction <docs/en/develop/3-12-Menu-introduction.md>`__\n- `Route introduction <docs/en/develop/3-13-Route-introduction.md>`__\n- `I18n introduction <docs/en/develop/3-14-I18n-introduction.md>`__\n\nHow to test\n~~~~~~~~~~~\n\n- `Two kinds of tests <docs/en/test/1-ready-to-work.md>`__\n- `Directory structure <docs/en/test/2-catalog-introduction.md>`__\n- `How to edit e2e case <docs/en/test/3-0-how-to-edit-e2e-case.md>`__\n- `E2E - Form operation <docs/en/test/3-1-E2E-form-operation.md>`__\n- `E2E - Table operation <docs/en/test/3-2-E2E-table-operation.md>`__\n- `E2E - Detail operation <docs/en/test/3-3-E2E-detail-operation.md>`__\n- `E2E - Resource\n operation <docs/en/test/3-4-E2E-resource-operation.md>`__\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "OpenStack Skyline Console",
"version": "4.0.0",
"project_urls": {
"Homepage": "https://docs.openstack.org/skyline-console/latest/",
"Source": "https://opendev.org/openstack/skyline-console",
"Tracker": "https://bugs.launchpad.net/skyline-console"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fea6699254df8d69eac7af62a4dacce2c2ced51214b3b2e855497e360fac4757",
"md5": "5a9ecca479ca6c76c4fffe31ebd80cc5",
"sha256": "2822d446c8005b2e512176fa7e8a5f4cc491d413666dd93c1610bf178bcca14b"
},
"downloads": -1,
"filename": "skyline_console-4.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a9ecca479ca6c76c4fffe31ebd80cc5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6227236,
"upload_time": "2024-04-03T11:54:16",
"upload_time_iso_8601": "2024-04-03T11:54:16.609960Z",
"url": "https://files.pythonhosted.org/packages/fe/a6/699254df8d69eac7af62a4dacce2c2ced51214b3b2e855497e360fac4757/skyline_console-4.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-03 11:54:16",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "skyline-console"
}
JSON