Giter Club home page Giter Club logo

pocketreporter's Introduction

Pocket Reporter

HELP WANTED: We don't have the capacity to maintain this app. We're looking for community volunteers to help us out and keep it going. Please email [email protected] if you're interested.

PocketReporter is an mobile app for Android devices that helps you be a better reporter by guiding you through the news gathering process.

PocketReporter is a simple client-only Javascript app based on Backbone.js and built using Phonegap Build.

The app branch is the app itself, the gh-pages branch is the website.

Local development

Local development uses the PhoneGap simulator.

  1. Clone the repo and cd into the repo directory
  2. Switch to the app branch: git checkout app
  3. Download the PhoneGap app
  4. Run PhoneGap and add the PocketReporter directory, and start the app in PhoneGap
  5. Visit the URL shown in PhoneGap

You can also use any local webserver that servers files from the filesystem. We use Jekyll.

  1. Check out the repo and app branch as above
  2. Start any local webserver, such as Jekyll: jekyll server
  3. You can also use python: python -m SimpleHTTPServer 4000
  4. Open www/js/main.js and uncomment the line that says // this.onDeviceReady();
  5. Visit the site in your browser: http://localhost:4000

Updating translations

  1. Download the translations file from CrowdIn.com
  2. Make a note of the language code (eg. en-za or xh)
  3. Import it into js/l10n.js by running:
    python strings.py --file download.csv --language LANGUAGE_CODE
  4. Check the new strings in the app
  5. Sanity check the changes using git diff
  6. Commit as usual

Building and deploying

Phonegap is built on Phonegap Build by pulling directly from the app branch of the repo.

License and Copyright

Copyright (c) 2016, 2017 OpenUp

Licensed under the MIT license.

The Pocket Reporter name and logo are Copyright 2016 OpenUp, and may not be used without permission.

Attribution

Pocket Reporter is the brainchild of Raymond Joseph and is inspired by the Virtual Reporter tool by Kanthan Pillay.

The logo is a derivative of this Freepik icon.

You're welcome to re-use this code to build your own application, provided you give it a new name and logo, provide attribution to Pocket Reporter and OpenUp, and follow the requirements of the MIT License.

pocketreporter's People

Contributors

longhotsummer avatar smmbll avatar guushoekman avatar schalkventer avatar thanethomson avatar lailahr avatar

Watchers

Hamza Mousa avatar James Cloos avatar Mohamed Aymane Zizi 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.