https://github.com/bellingcat/ukraine-timemap
TimeMap instance for Civilian Harm in Ukraine
https://github.com/bellingcat/ukraine-timemap
civilian-harm docker javascript open-source-research service timemap ukraine
Last synced: 3 months ago
JSON representation
TimeMap instance for Civilian Harm in Ukraine
- Host: GitHub
- URL: https://github.com/bellingcat/ukraine-timemap
- Owner: bellingcat
- License: other
- Created: 2022-03-21T09:09:33.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-21T10:50:18.000Z (about 1 year ago)
- Last Synced: 2024-08-21T11:50:59.322Z (about 1 year ago)
- Topics: civilian-harm, docker, javascript, open-source-research, service, timemap, ukraine
- Language: JavaScript
- Homepage: https://ukraine.bellingcat.com/
- Size: 8.97 MB
- Stars: 245
- Watchers: 6
- Forks: 39
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
Civilian Harm in Ukraine TimeMap
Explore it in ukraine.bellingcat.com
Download/integrate the data from here (regularly updated dataset)
Read Bellingcat's article about this project in
English (UK),
Русский (Россия)
TimeMap is a tool for exploration, monitoring and classification of incidents in time and space, originally forked from forensic-architecture/timemap.
## Development
* `npm install` to setup
* adjust any local configs in [config.js](config.js)
* `CONFIG=config.js npm run dev` or `npm run dev` if the file is named config.js
* For more info visit the [original repo](https://github.com/forensic-architecture/timemap)
## Deployment
This project is now living in github pages and the API has switched to auto-updated S3 files.
Access it at https://bellingcat-embeds.ams3.cdn.digitaloceanspaces.com/production/ukr/timemap/api.json
Release with `npm run deploy`.
## Contributing
Please read our [Contribution Guide](./CONTRIBUTING.md) and check our [Issues Page](https://github.com/bellingcat/ukraine-timemap/issues) for desired contributions, and feel free to suggest your own.
## Configurations
Documentation of config.js
* `SERVER_ROOT` - points to the API base address
* `XXXX_EXT` - points to the respective JSONs of the data, for events, sources, and associations
* `API_DATA` - S3 file address that can be downloaded or integrated into external apps/visualizations
* `MAPBOX_TOKEN` - used to load the custom styles
* `DATE_FMT` and `TIME_FMT` - how to consume the events' date/time from the API
* `store.app.map` - configures the initial map view and the UX limits
* `store.app.cluster` - configures how clusters/bubbles are grouped into larger clusters, larger `radius` means bigger cluster bubbles
* `store.app.timeline` - configure timeline ranges, zoom level options, and default range
* `store.app.intro` - the intro panel that shows on start
* `store.app.cover` - configuration for the full page cover, the `description` is a list of markdown entities, can also contain html
* `store.ui.colors` and `store.ui.maxNumOfColors` are applied to filters, as they are selected
Easiest way to deploy the static files is through
* `nvm use 16`
* `npm run build` (rather: `CI=false npm run build`)
* copy the files to your server, for example to `/var/www/html`