Skip to content

Latest commit

 

History

History
26 lines (16 loc) · 1.18 KB

README.md

File metadata and controls

26 lines (16 loc) · 1.18 KB

jump-api

API and backend for Unsub.

Frontend is at https://github.com/ourresearch/get-unsub

Live production at https://unsub.org

See the mapping file for a high level overview of what all the files are

Unsub and Open Source

The Unsub application is open source. We think it's important that users can inspect code underlying the Unsub application. There are however two important distinctions from other open source software you may be familiar with. First, we are not able to accept code contributions. We are a small team and it takes time to manage community contributions. Second, Unsub can not be run on its own. There is a significant component of user supplied data, as well as data curated in house, making it only possible to operate as a hosted application.

Documentation for this code

See the following files

  • Overview of project: README.md
  • Release nots: RELEASE_NOTES.md
  • License file: LICENSE
  • What are the files in this repo: docs/jump-api-mapping.md
  • How do bind variables work: docs/bind-variables.md
  • How to run staging vs. production and run tests: docs/running-unsub.md
  • How does caching work in this repo: docs/caching.md