CONTRIBUTING.md

Development Build

Install node.js.

https://nodejs.org/en/

Install global packages

just install-global

Or manually:

npm install -g \
	firebase-tools@latest \
	antlr4@latest \
	eslint@latest

Run the dev build:

just start

Or manually:

npm run dev

This will start the Vite dev server and run the app on localhost:5173. The app will be connecting to the production database.

Production build

Run the commands:

just build
just deploy

Or manually:

npm run build
firebase deploy

To see the firebase data

Install the Firebase CLI.

just install-global
just firebase-login

Or manually:

npm install -g firebase-tools
firebase login

just database-export

Or manually:

firebase database:get / > factorio-blueprints-export.json

The firebase database is essentially one big json document, and asking to download "/" is asking to download the whole thing. It will only download public info which means you might not have access to other users' favorites. If you need the whole database to read and understand, @FactorioBlueprints can share a copy. Here's some sample data.

{
	"blueprintSummaries": {
		"-KYVL2qnlOpHomJAj-eB": {
			"imgurId": "l5ajJXt",
			"imgurType": "image/jpeg",
			"lastUpdatedDate": 1498010275386,
			"numberOfFavorites": 71,
			"title": "☀️ MadZuri's Mk3 Solar Build"
		}
	},
	"blueprints": {
		"-KYVL2qnlOpHomJAj-eB": {
			"author": {
				"userId": "H3QlaVpvadfVuTpGGxs7016oR2K3"
			},
			"authorId": "H3QlaVpvadfVuTpGGxs7016oR2K3",
			"blueprintString": "0eNqdnctuG0cQRX <snipped>",
			"createdDate": 1481232629231,
			"descriptionMarkdown": "*Pretty* close to perfect ratios, tileable, 100% space efficient.\n\nYou can remove the roboports and replace them with accumulators to improve the ratio.",
			"favorites": {
				"EuA0qrMegObNUi83yFVJllIgCAO2": true,
				"YZ79eCKXovfsxXD9fmNAuyd9mlc2": true,
				"gikbOCGvWwY7hiFgsIoZrxMh4x93": true,
				"yEkV5AJi4TdlypuvUIb1yqbiznG3": true,
				"zuzzQ4UJUleX2sWuorCTBET66Tq1": true
			},
			"image": {
				"deletehash": "<masked>",
				"height": 644,
				"id": "l5ajJXt",
				"type": "image/jpeg",
				"width": 645
			},
			"imageUrl": "https://firebasestorage.googleapis.com/v0/b/facorio-blueprints.appspot.com/o/Zuris_Solar_Layout%5B1%5D.jpg?alt=media&token=3494c5fe-1dbc-46c3-8d40-83751c7e07b7",
			"lastUpdatedDate": 1498010275386,
			"numberOfFavorites": 71,
			"tags": ["/power/solar/", "/general/tileable/", "/mods/vanilla/", "/version/0,15/"],
			"title": "☀️ MadZuri's Mk3 Solar Build"
		}
	},
	"moderators": {
		"H3QlaVpvadfVuTpGGxs7016oR2K3": true
	},
	"users": {
		"H3QlaVpvadfVuTpGGxs7016oR2K3": {
			"blueprints": {
				"-KYVL2qnlOpHomJAj-eB": true,
				"-KY_A4qxNbkiBv1yNPI5": true
			},
			"displayName": "Factorio Blueprints",
			"email": "factorio.prints@gmail.com",
			"emailVerified": true,
			"favorites": {
				"-KYbIg8cULtwPnFfpb7b": true,
				"-KYpSfx8hRix5nVPBLwS": true
			},
			"photoURL": "https://lh3.googleusercontent.com/-XdUIqdMkCWA/AAAAAAAAAAI/AAAAAAAAAAA/4252rscbv5M/photo.jpg",
			"providerId": "google.com"
		}
	}
}