gbarkway / hypnospace-sitemap

An interactive map for Hypnospace Outlaw

Hypnospace Outlaw Sitemap

Currently hosted here!

An interactive map of Hypnospace, the alternate-reality Internet from the wonderful 2019 game Hypnospace Outlaw.

Run on your local machine

The below instructions require Docker and docker-compose

cd src
docker-compose --profile frontend up

The webapp is available at http://localhost:5000

Visit the subfolders listed below for more project-specific instructions, including how to run in a more development-friendly way.

Project structure

Name	Description	Path	Localhost port
Capture service	Backend service for sitemap graph data (i.e. edges between pages)	src/capture-serv	3001
Page service	Backend service for viewing and searching detailed page information	src/page-serv	3000
Webapp	Web frontend	src/web	5000
Crawler	Python scripts that parse Hypnospace Outlaw game data for use of above services	src/crawler

Contributing

Issues and pull requests welcome!

Deployment

There are some brief notes that might be useful to others in the deploy folder.

Building docker images for production

To build a docker image for every service and push them to a container registry:

1. Set the environment variables in src/.env (edit the file directly or set them in your shell)
2. docker-compose build --profile frontend
3. docker-compose push