Skip to content
This repository has been archived by the owner on Mar 29, 2022. It is now read-only.

Support Linux environment setup for development #417

Open
johndbritton opened this issue Nov 7, 2019 · 4 comments
Open

Support Linux environment setup for development #417

johndbritton opened this issue Nov 7, 2019 · 4 comments
Labels
environment Development, test, CI, deployment, and related issues help-wanted Looking for help from open source contributors

Comments

@johndbritton
Copy link
Contributor

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.

@johndbritton johndbritton added environment Development, test, CI, deployment, and related issues help-wanted Looking for help from open source contributors labels Nov 12, 2019
@Ana06
Copy link

Ana06 commented Jan 3, 2020

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 🤔

@Ana06
Copy link

Ana06 commented Jan 3, 2020

I have just set up the project in openSUSE and that is what I needed to do:

  1. Install the Ruby version specified in .ruby-version
  2. Install PostgreSQL (including the development package). Start PostreSQL systemd service and create a PostgreSQL superuser.
  3. gem install bundler dotenv
  4. cp config/dotenv.template .env
  5. Fill the .env file
  6. bundle install
  7. rake 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).

@MattIPv4
Copy link
Member

MattIPv4 commented Jan 3, 2020

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.

@johndbritton
Copy link
Contributor Author

johndbritton commented Jan 3, 2020

Step 2 for a Mac should be handled by Homebrew, just need to add the relevant packages to Brewfile.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
environment Development, test, CI, deployment, and related issues help-wanted Looking for help from open source contributors
Projects
None yet
Development

No branches or pull requests

3 participants