mirror of
https://github.com/bellingcat/ukraine-timemap.git
synced 2026-06-08 03:18:36 +03:00
adding some config instructions
This commit is contained in:
25
README.md
25
README.md
@@ -26,4 +26,27 @@ Read Bellingcat's article about this project in
|
||||
* For more info visit the [original repo](https://github.com/forensic-architecture/timemap)
|
||||
|
||||
## Contributing
|
||||
Please check our [issues page](https://github.com/bellingcat/ukraine-timemap/issues) for desired contributions, and feel free to suggest your own.
|
||||
Please check our [issues page](https://github.com/bellingcat/ukraine-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
|
||||
* `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 14`
|
||||
* `npm run build` (rather: `CI=false npm run build`)
|
||||
* copy the files to your server, for example to `/var/www/html`
|
||||
|
||||
</details>
|
||||
Reference in New Issue
Block a user