README.md

oss-valentines (https://oss.love)

Originally built by a small team at Netlify. Now maintained by @lynnandtonic and presented by OpenSauced and ui.dev.

Overview

This site was built to allow people to express their appreciation of open source contributors and organisations by selecting a greeting card, adding a recipient and sender name, and generating a unique URL for their customised card which they could share. The site uses:

• Eleventy for site templating
• Netlify Functions and on-demand builders for creating unique pages on demand
• Supabase via Netlify Functions for data persistence and retrieval
• Cloudinary for generating composite open graph images
• Netlify Graph for simplified API querying
• GitHub oAuth for user authenticaion

Development

The site uses some templating via 11ty.

# install dependencies
npm i

# build, serve and watch with 11ty during development
# do this via Netlify Dev in order to get ODB goodies
ntl dev

Access to the database (Supabase) is provided by environment variables. Authorised Netlifyers will be able to access these by linking their local site to the Netlfy project via ntl link. This will populate your local development version with the centrally-managed environment variables.

Others will need to create their own Suapbase database and add their own environment variables to access it.

Auth for local development

To test the GitHub oAuth flow on a local development server you can expose your local deve server on a public URL using Netlify Dev.

# Run a local dev server and serve it on a public URL
ntl dev --live

This will generate a unique public URL which is valid for the duration of the local server's life. Each time you kill the server and run it again, you'll get a new unique URL.

You can provide this URL to GitHub as the basis for an oAuth application. In production this is oAuth application is maintained under the Netlify account and associated with the https://oss.love domain.

To create your own GitHub oAuth application for local testing visit the Developer Settings section of your profile

Here you can create a new oAuth Application and provide some details. Providing the public URL of your local dev server will enable you to test the athentication flow and authenticated features of the site.

Setting	Value
Homepage URL	https://oss-valentine-XXXXX.netlify.live/ (provided by ntl dev --live)
Authorization callback URLL	https://oss-valentine-XXXXX.netlify.live/auth/callback