Introduction

This is the repository for https://srcery.sh. All contributions are welcomed and encouraged.

🌐 Visit Website

Libraries

• Astro
• Tailwind CSS - Rapidly build modern websites without ever leaving your HTML.
• Font Awesome
• DEVICON | All programming languages and development tools related icons font
• highlight.js
• Simple Icons
• Biome, toolchain of the web
• octokit/octokit.js: The all-batteries-included GitHub SDK for Browsers, Node.js, and Deno.
• Lodash

Running Locally

Install dependencies:

pnpm install

Fetch GitHub data to src/github.json

pnpm run fetch

Running the development server

pnpm start

Runs a live reload Astro (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.