Skip to content
Mat Schaffer edited this page May 3, 2021 · 11 revisions

You want to help out with Safecast? Awesome! 👍

Things to know

A good portion of our data processing code at Safecast is in Ruby on Rails. Being familiar with that is a good place to start. The getting started guide might be a good place to start.

We also need to do a lot of work at the data tier. Postgres with Postgis (intro) and Elasticsearch (definitive guide) are our main databases. You'll want to to start getting familiar with those as well, but you can probably learn as you go.

Finally most everything is deployed on AWS, so knowledge of working with that platform will be beneficial.

If you don't have background in these that's okay too. Just plan to be learning for a bit. :)

Getting started

First, get the main API app up and running for yourself using one of these docs for your OS:

Then have a look at our "help wanted" issues to see if there's anything that strikes your fancy.

Comment on it with your thoughts, open a pull request with a proposed fix.

Going deeper

Our wiki home page has a clickable infrastructure diagram that can be helpful in learning more about how the system works.

We also coordinate a fair bit over slack. Email [email protected] for access to that. He can also add you to the github org so you can start assigning issues to yourself.

And finally check out the Project Management page a link to our shared calendar and planning board.

Clone this wiki locally