Giter VIP home page Giter VIP logo

traceprivately's Introduction

TracePrivately

A sample app using Apple's contact tracing framework, as documented here:

https://www.apple.com/covid19/contacttracing

Note: The Apple framework is not actually yet released. This app is being developed using a mock version of the framework based on the published documentation. This will generate false exposures for the purposes of testing and development.

This app will be evolving quickly as I'm trying to publish new functionality as quickly as possible.

Objectives

  • Create a fully-functioning prototype that governments can use as an almost-turnkey solution that they can rebrand as necessary and use
  • Implement correct security and privacy principles to maximise uptake of said government apps
  • Remain open source for independent verification
  • Properly use the Apple / Google contact tracing specification
  • Work in a localized manner so it can be used in any language or jurisdiction
  • Create a functioning server prototype that can be used as a basis for more robust solutions that fit into governments' existing architecture.

How Can You Help?

There are a number of ways you can help. You can:

  • We need non-English translations: CrunchyBagel#30
  • We need an Android implementation: CrunchyBagel#32
  • We need testing (download, install, try the app - submit any issues you find). Pull requests with unit tests also welcome.
  • Suggestions, ideas, thoughts about any aspect of the app.

Instructions

  1. Set up a key server using the sample code in KeyServer
  2. In the iOS project, configure KeyServer.plist to point to your server
  3. Build and run in Xcode
  4. The sample key server requires manual approval of infection submissions, using the ./tools/pending.php and ./tools/approve.php scripts.
  5. In this proof of concept, every client will detect an exposure for any infection submitted

Localizations

If you can help translate the app, please help our crowd-sourced effort here:

https://traceprivately.oneskyapp.com/collaboration/project?id=170066

Currently available in: French, Spanish, Portuguese, Croatian and Hindi.

Screenshots

Main Window

Submit Window

Exposed Details Window

Other

  • Please submit suggestions and pull requests so this can function as best as possible.
  • Refer to the KeyServer directory for information about the server-side aspect of contact tracing.
  • Android? If you would like to build a clone of this iOS app in Android we can include or link to it from this repo.

License

Refer to the LICENSE file.

traceprivately's People

Contributors

hendx avatar kevinrmblr avatar tridie2000 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.