Open Ashish-CodeJourney opened 1 week ago
👍
👍
Hi @Ashish-CodeJourney, thank you for opening up the issue!
Are you referencing the online docs (https://rafiki.dev/integration/playground/overview) or the README in localenv folder in particular?
I think clarifying the environment setup commands in the live rafiki.dev docs will be helpful in particular
Hi @Ashish-CodeJourney, thank you for opening up the issue!
Are you referencing the online docs (https://rafiki.dev/integration/playground/overview) or the README in localenv folder in particular?
I think clarifying the environment setup commands in the live rafiki.dev docs will be helpful in particular
https://github.com/interledger/rafiki/blob/main/README.md#environment-setup https://github.com/interledger/rafiki/blob/main/localenv
these both part's are just pointing to each other creating problems in dev's understanding of how to set local environment
additionally, for local development, Docker is required, so it's a good idea to add information about prerequisite [tools] for whatever is required
Discussion:
As I was setting up the local environment for this project, I noticed that the file structure is a bit complex, and the current setup guide lacks sufficient detail specially for newbies. To ensure that new contributors can quickly get started and contribute effectively, I believe we could enhance the documentation with the following:
1. Prerequisites for Local Setup:
It would be helpful to list the prerequisites explicitly, such as the tools and software needed before starting. This might include:
2. Dependencies/Tools Required:
Clear instructions on installing the required tools should be added:
kubectl
,docker-compose
, etc., should be documented.3. Build Systems:
Clarify the required build systems with step-by-step commands:
gradle build
,gradle test
, etc.) if applicable.npm install
), build the project (npm run build
), and handle scripts (npm run start
, etc.).4. Database and Environment Setup:
The current setup doesn't fully mention the databases or environment variables required. I suggest adding:
.env
file), and what values they should contain (with example files or documentation).5. Step-by-Step Setup Guide:
We could improve the setup guide by including:
Example:
This level of detail would greatly assist future contributors and streamline the onboarding process. I'd love to hear the thoughts of other contributors and maintainers on this!
Thank you!
[PS: contribution guidelines and docs are great for experienced devs but it will be good for newbies if we create a separate guide specially when its mono repo containing multiple sub repos]