f-klubben / nottherealstregsystem

*DEPRICATED* The Stregsystem is used at F-Klubben to pay for goods bought at Strandvejen and for signup to various events held by F-klubben.
http://fff.fklub.dk/treo/stregsystem
Other
6 stars 2 forks source link

Add README to detail project contributing #15

Closed HenrikOssipoff closed 9 years ago

HenrikOssipoff commented 9 years ago

Added a rather large README file that describes how to work on the project, on either Ubuntu or OS X.

Also wrote sections on code style, how virtual environments work, as well as some reading on how to actually do your first pull request.

This was meant to be short, but turned into something rather large. It details the work of #9.

Awaiting feedback, I'm sure there's something that could be made better. Feel free to comment. If I don't hear anything before Monday, I'll merge in.

fishbacon commented 9 years ago

Made a PR changing the dev to 1.7 since some might find the "you are on the bleeding edge"-banner scary and the info has the potential of being incorrect (probably not since it is all guidelines).

HenrikOssipoff commented 9 years ago

Good point. The reason I chose dev was because it "isn't outdated" in 3 years, but I like your point better. We'll just need to keep it semi up to date.

coveralls commented 9 years ago

Coverage Status

Coverage remained the same at 75.76% when pulling 2f4095a162ec43a5cf08778e0ed46448ce4c1470 on HenrikOssipoff:issue_9 into 7c0dca93bef0207f7b62b71fa2e8cf5afbe699e4 on f-klubben:master.

fishbacon commented 9 years ago

If we are updating to 1.8 when that time comes we will make sure to update the links.

jones-g commented 9 years ago

Comments on README. Followed this on GnomeUbuntu 14.10

I went with using bundled Python3 and installed pip manually by doing: sudo apt-get install python3-pip

Went on to install git and python3.4-venv via: sudo apt-get install git python3.4-venv

Virtual environments is now working and reporting 3.4.3 as python version.

Getting the code commands need to be shuffled a bit I think.

Did clone, went to stregsystem folder, created virtual environment activated, changed to stregsystem folder (this is now the subfolder) did pip install -r requirements.txt -> failed the file is one folder up. Perhaps switch those two commands.

I ran into not having pg_config available. This can be fixed by: sudo apt-get install libpq-dev

python manage.py runserver now starts the server and shows a default page and /admin shows admin interface.

HenrikOssipoff commented 9 years ago

Right, so basically installing python3-pip will mean ensurepip works when using pyvenv-3.4. That seems simpler, I will do a quick test on a VM and adjust accordingly.

My bad on the missing change directory, will correct.

libpq-dev is documented, although with the compilation step. I'll fix that when changing to the python3-pip package.

I still like compiling manually, though -- but I'm weird like that :)

Thank you for the feedback, will ping once I've done an updated PR.

fishbacon commented 9 years ago

I will do a Windows install instruction this evening or Sunday if I find the time. It was pretty simple to do on 8.1 so I think it might be easy enough elsewhere too.

HenrikOssipoff commented 9 years ago

I wrote the changes proposed by @jones-g and rebased it all (I think it went well...).

@jones-g can you take a look again? I've tested the installation instructions against both 14.04 and 14.10 this time around -- thank you for the heads up! It seems they have not backported the fix to virtualenv yet, even though they plan on doing it.

coveralls commented 9 years ago

Coverage Status

Coverage remained the same at 75.76% when pulling 2c87c8a26b7b2e21384df0443c13cacbaad169f8 on HenrikOssipoff:issue_9 into 7c0dca93bef0207f7b62b71fa2e8cf5afbe699e4 on f-klubben:master.

fishbacon commented 9 years ago

Any progress on this?