Skip to content

Commit

Permalink
📝 document the local dev process
Browse files Browse the repository at this point in the history
  • Loading branch information
robmorieson committed Dec 23, 2022
1 parent f69ed08 commit ca40632
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,25 @@
A website for [perf.email](https://perf.email/): an up-to-date web platform news email to make you a better performance advocate.

Made by the team at [♠ Calibre](https://calibreapp.com/), your performance companion.

## Initial installation

`npm install`

## Running the project

`npm run dev` launches a local Vite dev server, accessible via [http://127.0.0.1:5173/](http://127.0.0.1:5173/).

Vite’s dev server watches for source file changes, performing a live reload if any are detected.

## Build and preview

The `npm run build` command generates production build files, output to the `/dest` directory.

To preview the build files locally, run the `npm run preview` command.

## RSS feed

`api/rss.js` leverages [Vercel’s serverless function](https://vercel.com/docs/concepts/functions/serverless-functions) capability to perform an on-demand request of [perf.email](https://perf.email/) issues from Mailchimp, returned as an RSS XML file.

The `MAILCHIMP_API_KEY` environment variable is required for the Mailchimp API call.

0 comments on commit ca40632

Please sign in to comment.