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

Document the requirements for running the project locally #112

Open
joaopalmeiro opened this issue Aug 26, 2024 · 1 comment · May be fixed by #113
Open

Document the requirements for running the project locally #112

joaopalmeiro opened this issue Aug 26, 2024 · 1 comment · May be fixed by #113
Labels
enhancement New feature or request

Comments

@joaopalmeiro
Copy link
Contributor

joaopalmeiro commented Aug 26, 2024

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:

  • Docker Desktop
  • Node.js 14 and npm 6 (given that the version of the package-lock.json file is version 1)
  • 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!

@joaopalmeiro joaopalmeiro added the enhancement New feature or request label Aug 26, 2024
@rubemlrm
Copy link
Collaborator

Hello @joaopalmeiro that looks good effort to be made. For me, you can go ahead with that PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
4 participants
@rubemlrm @joaopalmeiro and others