This lagrange-data-proxy is a Netlify function for loading and saving star system maps using Rentry.co. It can be configured as your organization's private "backend" for the lagrange data site.
- Create a Netlify account
- Clone or fork this repository to your own GitHub account
- Link the cloned respository to your Netlify account
- Go to your Netlify team overview page
- Click "Add new site" -> "Import existing project"
- Choose GitHub and select your cloned respository (you can ignore "Base directory", "Build command" and "Publish directory")
- Configure a site name (e.g. "maps-for-my-union")
- Check if it's deploying
(see Netlify's documentation on how to deploy functions if necessary)
- "RENTRY_AUTH" - your auth code for using Rentry's API (required)
- "ALLOWED_ORIGINS" - one or multiple comma-separated origins for CORS headers (optional)
(see Netlify's documentation on how to configure environment variables)
- Go to Rentry.co
- Enter some text (e.g. "$overlay Hello World!")
- Hit "Go" to save
- Take a note of your "edit code" (you will need this when saving maps)
- Check the URL in your adress bar and take a note of your file id (part after 'rentry.co/')
Your backend URL looks like this:
https://[your site name].netlify.app/.netlify/functions/mapFromRentryCo?map=[your Rentry.co file id]
Example:
https://maps-for-my-union.netlify.app/.netlify/functions/mapFromRentryCo?map=abc123
- Go to
lagrange-datasite -> "Maps" -> "Configure backend" - Paste the URL into the URL input field
- Click "LOAD MAP"
If the page can successfully load the map, it will store the given backend URL in the browser's localStorage (you won't have to paste it again).
After opening your map, you can copy the map URL from your adress bar to share it with others.
The map URL will directly open your map. Your backend URL is embedded in it, so others can directly open your map without configuring a backend URL themself. But because of that, your backend URL is kind of visible to everyone who knows your map URL. The free-tier of Netlify functions allows up to 125k requests per month, which is more than enough, but it's your bill if anything happens.