Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update index.rst Usage React with AssetMapper #1941

Open
wants to merge 3 commits into
base: 2.x
Choose a base branch
from

Conversation

xDeSwa
Copy link
Contributor

@xDeSwa xDeSwa commented Jun 26, 2024

Completing the documentation of usage with UX React with Asset Mapper

Completing the documentation of usage with UX React with Asset Mapper
@carsonbot carsonbot added the Status: Needs Review Needs to be reviewed label Jun 26, 2024
Completing the documentation of usage with UX React with Asset Mapper
Comment on lines +107 to +126
1- Create package.json in your project. This file is not included in the **Standard package**. (code below)

.. code-block:: json-object

{
"devDependencies": {
"@babel/cli": "^7.21.5",
"@babel/core": "^7.21.8",
"@babel/preset-react": "^7.18.6",
"svelte": "^3.59.1"
},
"license": "MIT",
"private": true,
"scripts": {
"build": "yarn build-react && yarn build-svelte",
"build-react": "babel assets/react --out-dir assets/build/react --presets=@babel/preset-react",
"build-svelte": "node bin/compile_svelte.js"
}
}

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we don't need to add the content of the package.json. Let's stay simple and say that we need a package.json and to install few dependencies.

JavaScript files:

.. code-block:: yaml

# config/packages/react.yaml
# config/packages/asset_mapper.yaml
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why change the file name ?


.. code-block:: terminal

$ npm install
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You use npm and below yarn. Let's stay on yarn

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Needs Review Needs to be reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants