search

rubyforgood / coral

An upcoming project for Ruby for Good
MIT License
13 stars 11 forks source link

Update to setup documentation #90

Closed meg-gutshall closed 4 years ago

meg-gutshall commented 4 years ago

Description

I went through the setup process in the CONTRIBUTING.md file and noticed some errors.

The commands were running out of the coral directory instead of the coral/rails directory which was giving back errors.

Also, I could not get the database to initialize because it couldn't find the POSTGRES_DB key. I was looking for a .env template and couldn't find one so decided to make one myself and make a few changes to the guide. If any other variables need to be added for the Docker setup (i.e. Sidekiq), please stick them in.

Type of change

Documentation update

Screenshot

Setup Issues Screenshot

meg-gutshall commented 4 years ago

I changed both .gitignore files to reflect the following patterns:

$ rails/.gitignore
.env*
!.env.example

$ .gitignore
.env*
!rails/.env.example

This should ignore all .env files except the example file which I created.

I sectioned off a few of the other patterns to make them more readable. In addition, I noticed that some of the duplicate patterns I had previously deleted weren't exact duplicates, so I consulted the Git docs and left the duplicate pattern with the broader scope (i.e. node_modules instead of /node_modules).