Code Monkey home page Code Monkey logo

pattrn's Introduction

Pattrn

Pattrn is a web platform for data-driven, participatory fact mapping. Its focus is on rapid deployment in the following contexts:

  • conflict monitoring
  • investigative journalism
  • human rights
  • citizen science
  • research and analysis

Quick start

For researchers and data scientists

Please see the Pattrn user manual: https://docs.pattrn.co/getting-started/index.html

For developers

  • Clone this repository or download a Pattrn v2.0 release as zip or tar.gz file

  • Install all the required NPM packages:

npm install

  • Modify the source-data-packages.json file (which is configured to use a sample dataset) to instruct the Pattrn build script to download and use the Pattrn data package configured; the content of this file should be as in the following example (replace pattrn-data-where-the-drones-strike with the name of your Pattrn data package, if using a different one):
{
  "source_data_packages": [
    {
      "package": "pattrn-data-where-the-drones-strike",
      "source": "https://gitlab.com/pattrn-data/pattrn-data-where-the-drones-strike.git#pattrn-data"
    }
  ]
}
  • Build the Pattrn application: this will download and use the data package configured in the previous step, and build all the assets needed for the live Pattrn instance:

npm run gulp build

  • Start a local web server to test the Pattrn app:

npm start

This command will display some messages while the web server is started, such as:

> [email protected] start /root/pattrn
> http-server dist/

Starting up http-server, serving dist/
Available on:
  http:127.0.0.1:8080
  http:10.2.200.149:8080
Hit CTRL-C to stop the server

You can now open the Pattrn app in a web browser; if no other service is using port 8080 on the computer, the address to use will be http://localhost:8080. If the messages above include a number other than 8080 (e.g. 8081), change the address accordingly (e.g. http://localhost:8081).

Authors and contributors

The PATTRN project was initiated thanks to a Proof-of-Concept Grant from the European Research Council, awarded to Prof. Eyal Weizman, in the framework of Forensic Architecture (2014-2015).

Pattrn v2.0

Pattrn v1.0

All new contributors to the PATTRN project will be duly credited.

License

Pattrn is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Pattrn is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with Pattrn. If not, see http://www.gnu.org/licenses/.

pattrn's People

Contributors

fsbrg avatar jh41 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.