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

https://github.com/solidjs/solid-assets

Access official dynamic and static assets from SolidJS. Made for the community! 🌟
https://github.com/solidjs/solid-assets

assets cloudflare-workers solid-js

Last synced: 7 months ago
JSON representation

Access official dynamic and static assets from SolidJS. Made for the community! 🌟

Awesome Lists containing this project

README

          


Solid Assets

# Solid Assets

Access official community assets for SolidJS through our simple asserts API; This provides the community with dynamic and static resources to get started with libraries and projects related to the SolidJS community.

## Usage

To get a banner for a project, use the following url:

```https://assets.solidjs.com/banner?project=```

If you want another type of background, you can choose between `tiles` and `blocks`.

```https://assets.solidjs.com/banner?project=&background=[tiles|blocks]```

## Development

The repository uses `pnpm` as the package manager. To install `pnpm`, run the following command in your terminal.

```bash
npm install -g pnpm
```

Run `pnpm install` to install all the dependencies for the packages.

Read more in [Contributing](CONTRIBUTING.md).

## Deployment

The repository is hosted on Cloudflare Workers. To deploy the repository, run the following command in your terminal.

```bash
pnpm run deploy
```

This will deploy the repository to Cloudflare Workers. For private deployments the url would be `solid-assets..workers.dev`.
Read more about [Cloudflare Workers](https://developers.cloudflare.com/workers/get-started/guide/#8-publish-your-project)