Support Linux environment setup for development
johndbritton opened this issue · comments
As a follow on to #400, we should DRY up the scripts folder so that script/setup correctly configures a development environment on Ubuntu/Debian Linux and script/cibuild relies on that same setup code to configure CI.
It would be nice to update the prerequisites as well:
Ensure your os is the latest MacOS
Contributing to this project gets too expensive if I need to buy a Mac 😜
Ubuntu/Debian Linux
It shouldn't be a big issue to support other Linux distributions as well 🤔
I have just set up the project in openSUSE and that is what I needed to do:
- Install the Ruby version specified in .ruby-version
- Install PostgreSQL (including the development package). Start PostreSQL systemd service and create a PostgreSQL superuser.
gem install bundler dotenvcp config/dotenv.template .env- Fill the
.envfile bundle installrake db:create db:migrate
Step 2. is not in the script so I assume that this is not needed in MacOS. 🤔
From step 3. everything works independently of the operative system. My proposal would be to mention steps 1 and 2 as requirements to the README (without detailing how to achieve it) and to keep only 3-7 in the script. I personally wouldn't document how to achieve steps 1 and 2 in the script and in the project documentation because it is different depending on the OS and distribution and it is not really part of the project. This makes it easier to maintain and there is extensive documentation how to do this on the internet. It may be a good idea to link other documentation though. Alternatively, steps 3-7 could be part of the set up documentation in the README (not necessarily in a script).
Step 2 would be needed on a fresh macOS install I think, I imagine it was just that most of us already have it installed/running for other things.
Step 2 for a Mac should be handled by Homebrew, just need to add the relevant packages to Brewfile.