You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
Right now, the root README file mentions the commands needed to run the project locally, but does not mention the necessary requirements. In other words, it would be useful to know which versions we should have installed locally of some dependencies like Node.js.
Describe the solution you'd like
Complement the Run & Go section with a list of requirements. Based on the first PR I opened, I think the minimum requirements needed are:
Python 2 (to install the necessary node-gyp version according to the package-lock.json file)
PHP 7 and Composer 1 (I would suggest to suggest using Composer via Docker since installing PHP 7 locally can be tricky, docker run --rm -it -v "$(pwd):/app" composer:1.10.19 install, and document the latest Docker tag of Composer 1 with PHP 7, that is, 1.10.19)
To complement this list, it could also be interesting to document the commands needed to install the right versions using known version managers (such as pyenv for Python and nvm/fnm for Node.js) to facilitate the preparation of the local environment.
Let me know what you think and if I can open a PR. Thanks!
The text was updated successfully, but these errors were encountered:
Hi! 👋
Is your feature request related to a problem? Please describe.
Right now, the root README file mentions the commands needed to run the project locally, but does not mention the necessary requirements. In other words, it would be useful to know which versions we should have installed locally of some dependencies like Node.js.
Describe the solution you'd like
Complement the
Run & Go
section with a list of requirements. Based on the first PR I opened, I think the minimum requirements needed are:package-lock.json
file is version 1)package-lock.json
file)docker run --rm -it -v "$(pwd):/app" composer:1.10.19 install
, and document the latest Docker tag of Composer 1 with PHP 7, that is,1.10.19
)To complement this list, it could also be interesting to document the commands needed to install the right versions using known version managers (such as pyenv for Python and nvm/fnm for Node.js) to facilitate the preparation of the local environment.
Let me know what you think and if I can open a PR. Thanks!
The text was updated successfully, but these errors were encountered: