README.md

Introduction

This is the repo for the Srcery website. All contributions are welcomed and encouraged.

View site

Web Stack

• Vite
• Alpine.js
• PostCSS
• TailwindCSS

Running Locally

Install dependencies:

pnpm install

Fetch GitHub data

pnpm run fetch

Running the development server

pnpm start

Runs a live reload Vite server, see stdout for port

GitHub token

The fetch script fetches GitHub data, you should be able to fetch a few times before the rate limit it reached.

If you do hit the rate limit when trying to fetch data, create a scoped auth token, doesn't need any permissions, and define it in the environment variable $GH_TOKEN when running the fetch script.

Building for production

• Vite documentation

To build for production, make sure you have a copy of the github.json file in src, then run:

pnpm run build

If you want to serve the dist output you can run:

pnpm run preview

NOTE: ./dist folder needs to be built for the preview server to work

License

MIT License. See LICENSE for more information.