An open API service indexing awesome lists of open source software.

https://github.com/srcery-colors/srcery.sh

Contains the source for the project website.
https://github.com/srcery-colors/srcery.sh

color-scheme colorscheme hacktoberfest parcel parceljs postcss srcery tailwindcss website

Last synced: about 1 month ago
JSON representation

Contains the source for the project website.

Awesome Lists containing this project

README

          



















## Introduction

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

[View site](https://srcery.sh)

## Web Stack

- [Vite](https://vitejs.dev/)
- [Alpine.js](https://alpinejs.dev/)
- [PostCSS](https://postcss.org)
- [TailwindCSS](https://tailwindcss.com)

## Running Locally

Install dependencies:

```sh
pnpm install
```

Fetch GitHub data

```
pnpm run fetch
```

Running the development server

```sh
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](https://vitejs.dev/guide/build.html)

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.