Badgeyay: Review for installation setup steps

[S2606]

Check the installation steps on the docs folder and report any changes to be made .

[nemani]

Local Installation: Since we are using python3, the pip command should be
sudo -H pip3 install -r requirements.txt
and for running
python3 app/main.py

[S2606]

Hey @nemaniarjun thats a good point . What do you think @jajodiaraghav @niccokunzmann ?

[jajodiaraghav]

@nemaniarjun @S2606
I was thinking of setting up virtualenv for our app. This would make it easier.

[S2606]

@jajodiaraghav Ok are you working on this or should i?

[jajodiaraghav]

I was talking about this: https://pypi.python.org/pypi/virtualenv
http://www.pythonforbeginners.com/basics/how-to-use-python-virtualenv

We do not need vagrant at the moment (not sure). But we should add instructions of using virtualenv in docs.

I am not working on this. Feel free to claim the issue

[nemani]

I can take this up, do we want to add a venv to the repo? or Just add instructions on how to make it locally?

[niccokunzmann]

@nemaniarjun You can add a venv. Sounds good. You can create a PR with the changes you would make to the tutorial.

[palnabarun]

@niccokunzmann @jajodiaraghav One question, why do you need to have a venv in the repo? A simple development setup instruction will suffice in letting the contributors know how to get started. What are your views?

[niccokunzmann]

@palnabarun I would go with your decision. As a new contributor, you know best what new contributors need.

[jajodiaraghav]

I agree with @palnabarun
The issue was opened for discussing the best approach. I think a dev setup instructions doc would do :)

[palnabarun]

So, should I add Dev setup instructions here ?

[jajodiaraghav]

No. Please add it inside the doc/installation folder. and put the link in Readme.md later

[palnabarun]

A dev setup document is already there here. This can be edited to add the virtualenv parts in between Point 1 and Point 2 in between the Steps section.

[palnabarun]

One more thing, the local setup doc says to clone it from fossasia/badgeyay which I feel is not the right way. The contributor should first fork the repo, clone their fork and then add fossasia/badgeyay as an upstream repo. What are your views? @niccokunzmann @jajodiaraghav

[niccokunzmann]

This sounds good: It will remove the extra steps for adding a remote for their fork once they have a patch.

[jajodiaraghav]

the local setup doc says to clone it from fossasia/badgeyay which I feel is not the right way.

You are right! We must have overlooked this part while merging. It would be great if you could fix this as well :)