Solidex

The following is a list of articles, packages and other resources that focus on the SolidJS ecosystem. Solidex is a platform for listing and maintaining these resources is an organized and well-defined manner. This repository acts as a dependency for Solid Site and other future Solid-powered projects.

Resources in Solidex have been vetted by a team member, organized and tagged. We consider this a central source of information for our entire community. We accept PRs to add packages to resources and these are supplied upstream to various SolidJS public and private utilities including our future CLI.

Adding Your Resource

To add to the list of Articles, Podcasts, Videos and Packages, modify the resource files in resources/ and submit a PR. A team member will review your submission to ensuring tagging and details related to the package meet the Solidex standard.

We maintain these asset in TypeScript to take advantgae of type support. This maintains taconomy, structure and correctness of the data. It also makes it easy to transform the dataset into different formats including Markdown and JSON.

Scripts

yarn build:json: Generates the index.json file in the root

Resource List

dist/articles.json: JSON list of article resources.
dist/videos.json: JSON list of video resources.
dist/packages.json: JSON list of packages and utilities.
dist/podcasts.json: JSON list of podcasts.

Comments

Port to JSON, rework TypeScript types
First, cleaning up types before porting data over. This aims to make types (and lists of type values) easy to consume e.g. in solid-site.

Replace enums with arrays (for easy enumeration in JS plus automatic types)

Split Resource vs. Package (Ecosystem for the union). Are we happy with this terminology? (It matches solid-site's current notation.)

Drop "library" option for Packages. We discussed this a long time ago; I don't think there's a useful distinction between "package" and "library". (I could still see calling the merged type "software"...)

Switch from Unix timestamps to ISO date times

Rename ResourceCategories into Categories.

?? Should we split Categories into PackageCategories and ResourceCategories? It looks like Educational is the one and only one used by resources. It's also used in one package, so I guess it could be listed twice...

Add annotations and script for generating JSON schema! yarn build:schema generates schema.json.

Second, restructure to use individual JSON files in data. dist is no longer in the repo but is still in the JSON export. Many more scripts.
opened by edemaine 1