Simplify Installation Instructions for Better Onboarding Experience ( Documentation / Installation )

[duyaan]

Is your feature request related to a problem? Please describe.
Yes. The current installation instructions in the documentation only show how to install react-admin via npm or yarn, which can be confusing or lead to issues for students or beginners. I personally faced difficulties using that method, and it's not the most straightforward approach for someone trying to get the project running quickly.

Describe the solution you'd like
I’d like to update the documentation and the CONTRIBUTING.md file to include an easier and faster installation method. This method works smoothly and avoids the problems I encountered using the existing instructions. The proposed steps are:

git clone
yarn install
cd react-admin
yarn run-simple

This approach is more accessible for new contributors and ensures the project is set up correctly with fewer steps and complications.

Describe alternatives you've considered

°Keeping the current installation instructions, but they may continue to cause confusion for beginners.
°Adding a troubleshooting section instead, but that doesn’t simplify the process as much as updating the steps directly.

Additional context
This change would make the onboarding process much smoother for students or new contributors. I can provide a pull request to add this to both the main documentation and the CONTRIBUTING.md file if needed.

[fzaninotto]

Can you please explain what you're trying to do:

1. clone the repo and install its dependencies to start hacking it, in order to improve the framework
2. create a new React application built around react-admin
3. add react-admin to an existing project

[duyaan]

Thanks for the clarification! I’m actually cloning the repo to run it locally and contribute to the framework.
I noticed that while the setup method using yarn install and yarn run-simple is already mentioned somewhere in the project, it's not highlighted in the main installation section or in the CONTRIBUTING.md. As a beginner myself, I had to dig around a bit to find it, and that slowed me down.
I’d love to make a small contribution to surface that method earlier—maybe in the README or right at the top of the contributing guide—so new contributors can get started faster without confusion.
I think this small improvement could go a long way in making onboarding easier and more welcoming for first-time contributors.