-
-
Notifications
You must be signed in to change notification settings - Fork 25
Onboarding
You want to help out with Safecast? Awesome! 🧡
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. This comprehensive video tutorial is another good starting point.
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. :)
First, get the main API app up and running for yourself using one of these docs for your OS:
- https://github.com/Safecast/safecastapi/wiki/Dev:-Setup-on-Linux-and-OS-X-using-Docker
- https://github.com/Safecast/safecastapi/wiki/Dev:-Setup-on-Windows
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.
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 the safecast-japan group for access to that. Once you get going we can add you to the github org to start assigning issues and making changes to the project board as you go.
And finally check out the Project Management page a link to our shared calendar and planning board.