-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from OSINT-for-Ukraine/README-update
Update README.md
- Loading branch information
Showing
1 changed file
with
32 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,63 +1,50 @@ | ||
| <h1 align="center">Project Mariupol TimeMap</h1> | ||
|
|
||
| <h2 align="center"> | ||
| Explore it in <a href="https://map.osintforukraine.com/">map.osintforukraine.com</a> | ||
| </h2> | ||
|  | ||
|
|
||
| <p align="center"> | ||
| <strong> | ||
| TimeMap is a tool for exploration, monitoring and classification of incidents in time and space, originally forked from <a href="https://github.com/bellingcat/ukraine-timemap">Bellingcat's Civilian Harm Ukraine-Timemap</a>. | ||
| <br> | ||
| Also, credits to forensic-architecture for the original repository: <a href="https://github.com/forensic-architecture/timemap">forensic-architecture/timemap</a>. | ||
| TimeMap is a tool for exploration, monitoring and classification of incidents in time and space, originally forked from Bellingcat's <a href="https://github.com/bellingcat/ukraine-timemap">Civilian Harm Ukraine-Timemap</a>, with special thanks to <a href="https://github.com/forensic-architecture">Forensic Architecture</a> for the original repository: <a href="https://github.com/forensic-architecture/timemap">forensic-architecture/timemap</a>. | ||
| </strong> | ||
| </p> | ||
| <br> | ||
| <br> | ||
| ## Credits: | ||
| Vasile Popa | ||
| Filip Chudzyński | ||
| Richard Mwewa | ||
| Cătălina Hasnaș | ||
|
|
||
|
|
||
|  | ||
|
|
||
| ## 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) | ||
| * For production deployment: | ||
| * pm2 serve build/ 80 --name "map" --spa | ||
| ## Development Setup | ||
| 1. Run `npm install` to install dependencies | ||
| 2. Adjust any local configs in [config.js](config.js) | ||
| * Documentation of [config.js](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` | ||
|
|
||
| 3. Run `npm run dev` to start the development server. If you're using a custom config file, prefix the commad with `CONFIG=your_custom_config.js` | ||
| 4. For more info visit the [original repo](https://github.com/forensic-architecture/timemap) | ||
| 5. Run `pm2 serve build/ 80 --name "map" --spa` for production deployment | ||
|
|
||
| ## Deployment | ||
| This project is now living in github pages and the API has switched to auto-updated S3 files. | ||
|
|
||
| Release with `npm run deploy`. | ||
| Release with `npm run deploy` | ||
|
|
||
| ## Contributing | ||
| Please check our [issues page](https://github.com/OSINT-for-Ukraine/project-mariupol-timemap/issues) for desired contributions, and feel free to suggest your own. | ||
|
|
||
| ## Configurations | ||
|
|
||
| <details> | ||
| <summary>Documentation of <a href="config.js">config.js</a> </summary> | ||
|
|
||
| * `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` | ||
|
|
||
| </details> | ||
| ## Credits | ||
| * [Vasile Popa](https://github.com/popovvasile) | ||
| * [Filip Chudzyński](https://github.com/curcher) | ||
| * [Richard Mwewa](https://github.com/rly0nheart) | ||
| * [Cătălina Hasnaș](https://github.com/Catalina-Hasnas) |