Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/triestpa/atlas-of-thrones
An interactive "Game of Thrones" map powered by Leaflet, PostGIS, and Redis.
https://github.com/triestpa/atlas-of-thrones
api gameofthrones javascript koa leaflet maps postgis postgresql redis
Last synced: 12 days ago
JSON representation
An interactive "Game of Thrones" map powered by Leaflet, PostGIS, and Redis.
- Host: GitHub
- URL: https://github.com/triestpa/atlas-of-thrones
- Owner: triestpa
- License: other
- Created: 2017-08-28T05:32:00.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T17:36:51.000Z (almost 2 years ago)
- Last Synced: 2024-10-31T06:03:31.486Z (12 days ago)
- Topics: api, gameofthrones, javascript, koa, leaflet, maps, postgis, postgresql, redis
- Language: JavaScript
- Homepage: https://atlasofthrones.com/
- Size: 1.21 MB
- Stars: 280
- Watchers: 14
- Forks: 62
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Atlas-Of-Thrones
An interactive "Game of Thrones" map powered by Leaflet, PostGIS, and Redis.
Visit https://atlasofthrones.com/ to explore the application.
Visit http://blog.patricktriest.com/game-of-thrones-map-node-postgres-redis/ for a tutorial on building the backend, using Node.js, PostGIS, and Redis.
Visit https://blog.patricktriest.com/game-of-thrones-leaflet-webpack/ for part II of the tutorial, which provides a detailed guide to building the frontend webapp using Webpack, Leaflet, and framework-less Javascript components.
#### Structure
- `app/` - The front-end web application source.
- `public/` - The compiled and minified front-end code.
- `server/` - The Node.js API server code.
- `data_augmentation/` - A collection of scripts to augment the shapefile data with summary data scraped from various wikis.
- `geojson_preview` - A simple html page to preview geojson data on a map.
#### Setup
To setup the project, simply download or clone the project to your local machine and `npm install`.
You can find a SQL database dump here with all of the content pre-loaded and ready to be queried - https://cdn.patricktriest.com/atlas-of-thrones/atlas_of_thrones.sql
The only extra step is adding a `.env` file in order to properly initialize the required environment variables.
Here's an example `.env` file with sensible defaults for local development -
```
PORT=5000
DATABASE_URL=postgres://patrick@localhost:5432/atlas_of_thrones?ssl=false
REDIS_HOST=localhost
REDIS_PORT=6379
CORS_ORIGIN=http://localhost:8080
```
You'll need to change the username in the DATABASE_URL entry to match your PostgreSQL user credentials. Unless your name is "Patrick", that is, in which case it might already be fine.
Run `npm run dev` to start the API server on `localhost:5000`, and to build/watch/serve the frontend code from `localhost:8080`.
___
This app is 100% open-source, feel free to utilize the code however you would like.
```
The MIT License (MIT)
Copyright (c) 2018 Patrick Triest
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```