Contributor Documentation
Opened this issue · 9 comments
I found the project after the RailsConf talk about it. My nephew is autistic so the project really made an impact on me so I thought I'd contribute.
It seems like there's some documentation needs.
My thought is to add a CONTRIBUTING.md
file. A couple other things I noticed missing from the read me are project setup instructions & versions of various parts of the stack. I'd also recommend adding a .ruby-version
file. If you're cool with any of this and/or have any thoughts let me know and I can submit a PR for some of this.
Todos:
- Make
CONTRIBUTING.md
- Add/include in ^, Installation instructions
- Add
.ruby-version
@juliusdelta excellent, excellent idea. I definitely want to tackle this. I would be happy to have you review.
I tried to set up locally, it broke at: "step 4: bundle exec rake db:setup"
could not connect to server: Connection refused
Is the server running on host "localhost" (::1) and accepting
TCP/IP connections on port 5432?
could not connect to server: Connection refused
Is the server running on host "localhost" (127.0.0.1) and accepting
TCP/IP connections on port 5432?
Couldn't create database for {"adapter"=>"postgresql", "pool"=>5, "timeout"=>5000, "host"=>"localhost", "database"=>"cc-dev"}
rake aborted!
PG::ConnectionBad: could not connect to server: Connection refused
Is the server running on host "localhost" (::1) and accepting
TCP/IP connections on port 5432?
could not connect to server: Connection refused
Is the server running on host "localhost" (127.0.0.1) and accepting
TCP/IP connections on port 5432?
....
@wolffles This error means that you do not have PostgresQL running on your machine. Here is a guide on how to set it up on Mac.
https://www.moncefbelyamani.com/how-to-install-postgresql-on-a-mac-with-homebrew-and-lunchy/
@wonderwoman13 in step 6, is there an extra step like creating self-signed SSL certificate or does that start command cover that for me? I get SSL errors from the server when going to localhost.
2018-11-25 13:14:53 -0800: SSL error, peer: ::1, peer cert: , #<Puma::MiniSSL::SSLError: OpenSSL error: error:1407609C:SSL routines:SSL23_GET_CLIENT_HELLO:http request - 336027804>
I've tried using both absolute and relative path, server starts fine but doesn't send data.