Skip to content

Conversation

@saksham869
Copy link
Contributor

Hi Team,
This pull request enhances the project documentation by improving the README.md file.
It introduces a concise Quickstart guide and an example .env configuration section, helping new contributors set up the environment efficiently.
Kindly review the proposed updates. I’ll be happy to make any further revisions based on your feedback.

Thank you...

@saksham869 saksham869 changed the title 📝 Description This pull request improves the project documentation by updating the README.md with a Quickstart guide and an example .env configuration section. It helps new contributors set up the project faster and understand required environment variables. 🧪 How to Test Locally Clone the repository and navigate to the project directory. git clone https://github.com/<your-username>/mifosx-ai.git cd mifosx-ai Follow the new Quickstart section in the README. Run: ./mvnw -B clean package ./mvnw spring-boot:run Confirm that the app starts successfully. ⚙️ Impact Docs-only change — no functional code modifications. 🔗 Related Issues None (documentation improvement only). 📝.. This pull request improves the project documentation by updating the README.md with a Quickstart guide and an example .env configuration section. It helps new contributors set up the project faster and understand required environment variables. 🧪 How to Test Locally Clone the repository and navigate to the project directory. git clone https://github.com/<your-username>/mifosx-ai.git cd mifosx-ai Follow the new Quickstart section in the README. Run: ./mvnw -B clean package ./mvnw spring-boot:run Confirm that the app starts successfully. ⚙️ Impact Docs-only change — no functional code modifications. 🔗 Related Issues None (documentation improvement only). Nov 8, 2025
@saksham869 saksham869 changed the title 📝.. This pull request improves the project documentation by updating the README.md with a Quickstart guide and an example .env configuration section. It helps new contributors set up the project faster and understand required environment variables. 🧪 How to Test Locally Clone the repository and navigate to the project directory. git clone https://github.com/<your-username>/mifosx-ai.git cd mifosx-ai Follow the new Quickstart section in the README. Run: ./mvnw -B clean package ./mvnw spring-boot:run Confirm that the app starts successfully. ⚙️ Impact Docs-only change — no functional code modifications. 🔗 Related Issues None (documentation improvement only). This PR improves the project documentation by updating the README.md with: A Quickstart guide to simplify local setup. An example .env configuration section to help contributors understand environment variables. These changes make onboarding new contributors faster and more efficient. Nov 8, 2025
@IOhacker IOhacker merged commit b827a8e into openMF:main Nov 23, 2025
@IOhacker
Copy link
Contributor

@saksham869 thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants