Safecast/safecastapi

The app that powers api.safecast.org

Overview

This is a rails app deployed in front of Postgres with Postgis. Data files generatated from various devices such as the bGeigie Nano and are uploaded to the production app at api.safecast.org.

From there applications query the app's endpoints to pull the stored data for other purposes.

See the Tilemap Project's README for more diagrams on the complete data flow.

There is also a development host located at dev.safecast.org which is used for testing features before rolling them to the main endpoint.

Contributing

Onboarding

Start here: Onboarding

Available Data Sets

Translation

Translation is managed by Locale and open to all.

You can edit translations on the Safecast/safecastapi project on Locale.

The maintainers will then pull translations from the Locale project and push to Github.

Happy translating!

Development

There are a few apps for Safecast data processing. See https://github.com/safecast/safecastapi/wiki for a high level view (and link to a deeper doc).

All issues for server-side work live in https://github.com/safecast/safecastapi/issues

See the help-wanted label for some issues that should be approachable for folks just getting started with the app.

See one of the wiki pages for instructions on setting up for local development:

• Dev: Setup on Linux and OS X using Docker
• Dev: Setup on Windows

And finally we have a Slack channel for real time coordination. Contact Mat Schaffer to get an invite.

Deployment

See Ops Readme.

Licensing

Licensing can be confusing. We’ll try to make it a little less so.

When you contribute to Safecast by participating in an event OR submitting content or information to a webpage OR submitting a pull request, testing or bug reporting OR sending data from your Safecast device then you license all of your contribution to Safecast and to all the world under these same licenses. Safecast will be attributed as the source.

Design, hardware, software, design and website content is shared by Safecast under the licenses specified below: - All Data is Creative Commons Zero, anyone is free to make any use of the data, attribution is not legally required but is encouraged. - All Design is Creative Commons Attribution Share-Alike, anyone is free to copy, edit and republish the design but must make it clear Safecast is the source and the design must be published under the same or a compatible license. - All functional aspects of design are under the Berkeley Software Distribution License in respect of copyright and the XL1.0 Cross License in respect of patent. - Web Content is under Creative Commons Attribution Non Commercial, anyone can copy and remix the what is on the website but must attribute Safecast and anyone else specified by Safecast. - “Safecast” and the safecast logo are Registered Trademarks of the Momoko Ito Foundation, a 501(c)3 Non-profit, you can't use them without permission. - Software is licensed under the MIT license unless otherwise specified.