search

thomersch / openstreetmap-calendar

osmcal, a Collaborative Calendar for OpenStreetMap-related Events
https://osmcal.org
Apache License 2.0
33 stars 9 forks source link

Update readme with developer guide #38

Closed ghost closed 4 years ago

ghost commented 4 years ago

Add some basic information of howto run developer environment to readme.

thomersch commented 4 years ago

Thanks for submitting!

It's generally a good idea to simplify the development flow. The issue is: personally I don't use docker and I wouldn't be able to maintain the documentation from this point. So, if we want to get this going, I would need you to keep this up-to-date in the future. Would you be willing to do this?

ghost commented 4 years ago

I plan to contribute to this project in my spare time a little bit more than just updating readme, so I will be around for a while.

Anyway, please, do not merge this PR yet, I will complete the developer's guide with information from #39 and so.

Btw, what is your developer's setup? You run the database locally? How is the project deployed without docker?

thomersch commented 4 years ago

I plan to contribute to this project in my spare time a little bit more than just updating readme, so I will be around for a while.

Awesome!

Btw, what is your developer's setup? You run the database locally? How is the project deployed without docker?

I just have PostgreSQL running on my machine running anyway, so I am using that.

The production osmcal runs in a jail on FreeBSD, with its own virtualenv using pipenv. It shares a PostgreSQL cluster with other applications. A GitHub action triggers a shell script on the executing machine which then pulls the latest source from git and restarts the application.

ghost commented 4 years ago

@thomersch so the developer's guide should be ok now. I was able to run the tests and local instance following Developer's guide section. Feel free to check it and merge if you consider it ready.

ghost commented 4 years ago

One small thing: I would rather avoid the manual wrapping at 80. For code is okayish, but for text it's really annoying when rewriting some sections. Also, most editors can wrap based on user preference.

I will cry, but ok.

ghost commented 4 years ago

Hi @thomersch, this is week bump :)