Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 37 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@

> [!TIP]
> Are you looking for an integration with VS Code? Check out our official extension:
> * https://github.com/react-native-community/vscode-react-native-directory
>
> - https://github.com/react-native-community/vscode-react-native-directory

## How do I know I'm at the right place?

Expand Down Expand Up @@ -44,10 +45,7 @@
{
"githubUrl": "<GITHUB REPOSITORY URL>",
"npmPkg": "<OPTIONAL NPM PACKAGE NAME>",
"examples": [
"<THE URL TO REPO>",
"<THE URL TO A SNACK>"
],
"examples": ["<THE URL TO REPO>", "<THE URL TO A SNACK>"],
"images": ["<PUBLIC URL TO RELATED IMAGE>"],
"ios": false,
"android": false,
Expand All @@ -56,6 +54,7 @@
"macos": false,
"tvos": false,
"visionos": false,
"vegaos": false,
"expoGo": false,
"fireos": false,
"unmaintained": false,
Expand All @@ -70,16 +69,16 @@
> then the name, description, homepage, and topics (keywords) will be extracted from `package.json` in the package subdirectory.
> However, GitHub stats will be based on the monorepo, because there isn't really another option.


### Library fields description

#### ⚙️ General

- #### ❗ `githubUrl` **(required)**

**(string)** - URL to the package GitHub repository (currently other Git hosts are not supported).
> [!WARNING]
> Package also needs to be published to the NPM registry, because it is a source of crucial data for the directory.

> [!WARNING]
> Package also needs to be published to the NPM registry, because it is a source of crucial data for the directory.

- #### `npmPkg`

Expand Down Expand Up @@ -126,6 +125,8 @@
**(boolean)** - works with [Expo Go](https://docs.expo.dev/get-started/expo-go/) — an open-source sandbox app, without using [dev clients](https://docs.expo.dev/develop/development-builds/introduction/) or [prebuild](https://docs.expo.dev/workflow/continuous-native-generation/).
- #### `fireos`
**(boolean)** - works on Amazon Fire OS.
- #### `vegaos`
**(boolean)** - works with [Vega OS](https://developer.amazon.com/docs/react-native-vega/0.72/react_overview.html).

> [!TIP]
> **Any** library can be used with Expo, if you use dev clients or prebuild.
Expand All @@ -147,6 +148,7 @@
### 📝 Additional context for tags

- #### `newArchitectureNote`

**(string)** - provide a note for the New Architecture support status, if a boolean `"true"` or `"false"` is not sufficient to describe the state of New Architecture support.

- #### `alternatives`
Expand All @@ -170,7 +172,7 @@ You should be able to visit `localhost:3000` in your browser.

- Visit https://github.com/settings/developers to get your keys (don't worry about the callback URL, put whatever you want).
- Load the `GITHUB_TOKEN` environment variable into your shell.
- Set `ONLY_WRITE_LOCAL_DATA_FILE` to `true` in *scripts/build-and-score-data.ts* to skip fetching and updating store blob from Vercel and instead use and update the local `assets/data.json` file.
- Set `ONLY_WRITE_LOCAL_DATA_FILE` to `true` in _scripts/build-and-score-data.ts_ to skip fetching and updating store blob from Vercel and instead use and update the local `assets/data.json` file.

This command creates site data in `./assets/data.json`

Expand All @@ -196,31 +198,32 @@ https://reactnative.directory/api/libraries
<summary><b>More details on API queries</b></summary>
<br/>

```
https://reactnative.directory/api/libraries?search=webgl
```

- Returns a list of all libraries in `JSON` format that have the keyword `webgl`.

```
https://reactnative.directory/api/libraries?search=webgl&expoGo=true
```

- Returns a list of all libraries in `JSON` format that have the keyword `webgl` and work with Expo Go app.

```
https://reactnative.directory/api/libraries?search=webgl&expoGo=true&android=true
```

- Returns a list of all libraries in `JSON` format that have the keyword `webgl`, work with Expo Go app and Android.

```
https://reactnative.directory/api/libraries?search=webgl&expoGo=true&android=true&isPopular=true
```

- Returns a list of all libraries in `JSON` format that have the keyword `webgl`, work with Expo Go app, Android and are popular based on the scoring criterion.

All the possible query parameters represents [`Query` type](https://github.com/react-native-community/directory/blob/main/types/index.ts#L14-L36).
```
https://reactnative.directory/api/libraries?search=webgl
```

- Returns a list of all libraries in `JSON` format that have the keyword `webgl`.

```
https://reactnative.directory/api/libraries?search=webgl&expoGo=true
```

- Returns a list of all libraries in `JSON` format that have the keyword `webgl` and work with Expo Go app.

```
https://reactnative.directory/api/libraries?search=webgl&expoGo=true&android=true
```

- Returns a list of all libraries in `JSON` format that have the keyword `webgl`, work with Expo Go app and Android.

```
https://reactnative.directory/api/libraries?search=webgl&expoGo=true&android=true&isPopular=true
```

- Returns a list of all libraries in `JSON` format that have the keyword `webgl`, work with Expo Go app, Android and are popular based on the scoring criterion.

All the possible query parameters represents [`Query` type](https://github.com/react-native-community/directory/blob/main/types/index.ts#L14-L36).

</details>

## I don't like how you calculate scores.
Expand Down
Loading