SCRATCH-MAP
An open-source scratch-off style map to track your travels.
Table of Contents
Features
- World Map
- US States Map
- Canadian Map
- Australian Map
- French Map
- Mexican Map
- Japanese Map
- Spanish Map
- British Map
- German Map
- New Zealand Map
- Brazilian Map
- Chinese Map
- Indian Map
- Date Traveled To Location
- Link a Photo Album URL to a Scratch
Running
Docker
The commands to create the data directory and set permissions are Linux specific.
mkdir -p /opt/docker/scratch-map/data
chown -R 1000:1000 /opt/docker/scratch-map/data
docker run -d --restart=always --name scratch-map -p 8080:8080 \
-e PORT=8080 -e DBLOCATION=/data \
-v /opt/docker/scratch-map/data:/data \
ad3m3r5/scratch-map:latest
Using NPM (any OS)
- Set ENV vars (see below) somewhere they will persist
npm install
npm run
Running as a Service (any OS)
This varies depending on the OS, however I would recommend checking out PM2.
Environment Variables
process.env.DBLOCATION
- (recommended) somewhere outside of app dir for update compatibility
- DEFAULT: APPDIR/data/
process.env.PORT
- (optional) port for app to run on
- DEFAULT: 3000
Tech Stack
- nodeJS (18.12.0)
- express
- pug
- lowdb
- nodemon
Screenshots
Credits
Libraries
- pan/zoom for SVGs
- scratch prompts/pop-ups
Fonts
- Roboto - used on SVG labels