Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Safecast/safecastapi

The app that powers api.safecast.org
https://github.com/Safecast/safecastapi

Last synced: 3 months ago
JSON representation

The app that powers api.safecast.org

Awesome Lists containing this project

README 

        
# Safecast/safecastapi

[![CircleCI](https://circleci.com/gh/Safecast/safecastapi.svg?style=svg)](https://circleci.com/gh/Safecast/safecastapi) [![Code Climate](https://codeclimate.com/github/Safecast/safecastapi/badges/gpa.svg)](https://codeclimate.com/github/Safecast/safecastapi) [![Test Coverage](https://codeclimate.com/github/Safecast/safecastapi/badges/coverage.svg)](https://codeclimate.com/github/Safecast/safecastapi/coverage) [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/safecast/safecastapi)



The app that powers [api.safecast.org](https://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](http://nano.safecast.org) 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](https://github.com/Safecast/Tilemap/) Project's README for more diagrams on the complete data flow.



There is also a development host located at [dev.safecast.org](https://dev.safecast.org) which is used for testing features before rolling them to the main endpoint.



## Contributing



### Onboarding



Start here: [Onboarding](https://github.com/Safecast/safecastapi/wiki/Onboarding)



Available [Data Sets](https://github.com/Safecast/safecastapi/wiki/Data-Sets#air-and-radiation-data-via-ingestsafecastorg)



### Translation



Translation is managed by [Locale](http://www.localeapp.com/) and open to all.



You can edit translations on the [Safecast/safecastapi](http://www.localeapp.com/projects/public?search=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](https://github.com/Safecast/safecastapi/issues?q=is%3Aopen+is%3Aissue+label%3Ahelp-wanted+sort%3Aupdated-desc) 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](https://github.com/Safecast/safecastapi/wiki/Dev:-Setup-on-Linux-and-OS-X-using-Docker)

* [Dev: Setup on Windows](https://github.com/Safecast/safecastapi/wiki/Dev:-Setup-on-Windows)



And finally we have a Slack channel for real time coordination. Contact [Mat Schaffer](http://github.com/matschaffer) to get an invite. 



### Deployment



See [Ops Readme](README.ops.md).



## 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][event] OR [submitting content or information to a webpage][blog] OR [submitting a pull request, testing or bug reporting][github] OR [sending data from your Safecast device][api] 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][CCZ], 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][CCASA], 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][BSD] in respect of copyright and the [XL1.0 Cross License][CL] in respect of patent.

- Web Content is under [Creative Commons Attribution Non Commercial][CCANC], 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][MIT] unless otherwise specified.



[event]: http://blog.safecast.org/2013/02/tokyo-hackathon-roundup/

[blog]: https://blog.safecast.org

[github]: https://github.com/Safecast/safecastapi

[api]: https://api.safecast.org



[CCZ]: http://creativecommons.org/publicdomain/zero/1.0/

[CCASA]: http://creativecommons.org/licenses/by-sa/4.0/

[BSD]: https://blog.safecast.org/bsd/

[CL]: http://blog.safecast.org/wp-content/uploads/2012/05/xl_crosslicense.pdf

[CCANC]: http://creativecommons.org/licenses/by-nc/3.0/

[MIT]: http://blog.safecast.org/mit/