Skip to content

Fix: Readme for Instructions to run using Docker on Windows#1607

Merged
vorburger merged 1 commit intoapache:developfrom
apurv-1:develop
Feb 7, 2021
Merged

Fix: Readme for Instructions to run using Docker on Windows#1607
vorburger merged 1 commit intoapache:developfrom
apurv-1:develop

Conversation

@apurv-1
Copy link
Contributor

@apurv-1 apurv-1 commented Feb 5, 2021

Description

Describe the changes made and why they were made.

I was setting up the Project on Windows 10, and it was throwing some "file not found error",
I searched for the problem and found that It was the issue with Docker on Windows,

So, One of the issues with Docker (or any Linux/macOS based system) on Windows is the difference in how line endings are handled. Windows ends lines in a carriage return and a linefeed \r\n while Linux and macOS only use a linefeed \n. This becomes a problem when you try to create a file in Windows and run it on a Linux/macOS system, because those systems treat the \r as a piece of text rather than a newline.

So, I cloned the repo with flag (--config core.autocrlf=input) and this worked.

Ignore if these details are present on the associated Apache Fineract JIRA ticket.

Checklist

Please make sure these boxes are checked before submitting your pull request - thanks!

  • Write the commit message as per https://github.com/apache/fineract/#pull-requests

  • Acknowledge that we will not review PRs that are not passing the build ("green") - it is your responsibility to get a proposed PR to pass the build, not primarily the project's maintainers.

  • Create/update unit or integration tests for verifying the changes made.

  • Follow coding conventions at https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions.

  • Add required Swagger annotation and update API documentation at fineract-provider/src/main/resources/static/api-docs/apiLive.htm with details of any API changes

  • Submission is not a "code dump". (Large changes can be made "in repository" via a branch. Ask on the developer mailing list for guidance, if required.)

FYI our guidelines for code reviews are at https://cwiki.apache.org/confluence/display/FINERACT/Code+Review+Guide.

Now to run a new Fineract instance you can simply:

1. `git clone https://github.com/apache/fineract.git ; cd fineract`
1. for windows, use `git clone https://github.com/apache/fineract.git --config core.autocrlf=input ; cd fineract`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@apurv-1 thank you for your first contribution to this project! I'll merge this as-is.

If you would like to make a 2nd contribution, you could change it to be part of the 1. instead of a 2. step.

@vorburger vorburger merged commit f7815ba into apache:develop Feb 7, 2021
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