You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+28-17Lines changed: 28 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,33 +52,41 @@ yarn lint:fix
52
52
yarn build
53
53
```
54
54
55
+
If you want to test a specific package, from the root directory run any of the above command with the `filter` flag.
56
+
57
+
Example:
58
+
```
59
+
turbo run test --filter=@meilisearch/instant-meilisearch
60
+
```
61
+
55
62
### Playgrounds <!-- omit in TOC -->
56
63
57
-
To test directly your changes in `instant-meilisearch`, you can run the Vue playground:
64
+
#### @meilisearch/instant-meilisearch playgrounds
58
65
66
+
To test directly your changes in `instant-meilisearch`, you can run the following playgrounds:
67
+
68
+
`Vue 3`
59
69
```bash
60
70
yarn playground:vue
61
71
```
62
72
63
-
Or the React playground:
73
+
`React`:
64
74
65
75
```bash
66
76
yarn playground:react
67
77
```
68
78
69
-
Or the JavaScript playground:
79
+
`Vanilla JS`:
70
80
```
71
81
yarn playground:javascript
72
82
```
73
83
74
-
Or the HTML playground:
84
+
`HTML`:
75
85
```
76
86
yarn playground:html
77
87
```
78
88
79
-
### Geo-Search Playground
80
-
81
-
A playground is available to try out the [GeoSearch](./README.md/-geo-search) in `instant-meilisearch`.
89
+
An additional playground is provided to test out the [GeoSearch](./packages/instant-meilisearch#-geo-search).
82
90
83
91
```bash
84
92
yarn playground:geo-javascript
@@ -105,10 +113,13 @@ We don't follow any other convention, but if you want to use one, we recommend [
105
113
106
114
### Changesets <!-- omit in TOC -->
107
115
108
-
We use [changesets](https://github.com/Noviny/changesets) to do versioning. What that means is that you need to [add a changeset](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md) by running `yarn changeset`. The changeset you create contains what packages should be bumped, their associated semver type and the changelogs.
116
+
We use [changesets](https://github.com/Noviny/changesets) to do versioning. What that means is that you need to [add a changeset](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md) by running `yarn changeset`. The changeset you create contains which packages should be bumped, their associated semver type and the changelogs.
117
+
118
+
119
+
> avant chaque release, les fichiers sont supprimés (voir process qui suit)
109
120
110
-
These changesets are added in the `.changesets` directory at the root of the repository, and should be added in your PR.
111
-
Once there is a [release](#release-on-github-and-npm), these files are automatically removed.
121
+
These changesets are added to the `.changesets` directory at the root of the repository, and should be added to your PR.
122
+
Before a release, these files are removed (see [process](#release-on-github-and-npm)).
112
123
113
124
Some changes do [not require a changeset](https://github.com/changesets/changesets/blob/main/docs/intro-to-using-changesets.md#not-every-change-requires-a-changeset). For example changes that does not impact the packages, e.g. : Updating the README.md or changes in tests files.
This project integrates a bot that helps us manage pull requests merging.<br>
132
143
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/resources/bors.md)._
133
144
134
-
### Release on Github and npm
145
+
### Release on GitHub and npm
135
146
136
-
This repository uses the [changesets](https://github.com/Noviny/changesets) library to handle the version updates and the publishing on Github and `npm`.
147
+
This repository uses the [changesets](https://github.com/Noviny/changesets) library to handle the version updates and the publishing on GitHub and `npm`.
137
148
138
-
When PR's are merged on `main`, they trigger the [`release` CI](./.github/workflows/publish.yml). This CI creates a PR titled `Version Packages` containing all the version updates and changelogs of the impacted packages. The PR updates the versions and the changelogs based on the `changesets` that were previously pushed on main (see [changeset section](#changesets)).
149
+
When PRs are merged on `main`, they trigger the [`release` CI](./.github/workflows/publish.yml). This CI creates a PR titled `Version Packages` containing all the version updates and changelogs of the impacted packages. The PR updates the versions and the changelogs based on the `changesets` that were previously pushed on main (see [changeset section](#changesets)).
139
150
140
-
To release on Github and `npm` you must merge the `Version packages` PR. This will trigger the publishing action and create the Github and `npm` releases for all affected packages.
151
+
To release on GitHub and `npm` you must merge the `Version packages` PR. This will trigger the publishing action and create the GitHub and `npm` releases for all affected packages.
141
152
142
153
See more in depth explaination on [versioning](https://github.com/changesets/changesets/blob/main/docs/command-line-options.md#version), [publishing](https://github.com/changesets/changesets/blob/main/docs/command-line-options.md#publish) and the [changesets github-action](https://github.com/changesets/action).
143
154
144
-
If you were previously on `pre-release mode`, do not forget to create a PR exiting the pre-release modeby doing`yarn changeset pre exit` and then merge it to main.
155
+
If you merged a beta branch, that was released, into main, you were probably in the `changesets`[pre-release](https://github.com/changesets/changesets/blob/main/docs/prereleases.md) mode (see section on [releasing a beta](#release-a-beta-version)). If the `pre.json` file is present in the `.changesets` folder, you need to exit that mode. This is possible by running`yarn changeset pre exit`. Once done, create a PR with the changes and merge it to main.
145
156
146
157
#### Codesandbox update
147
158
Once the version is available on npm, please update the instant-meilisearch version used in the different Code-Sandboxes we provide:
@@ -172,11 +183,11 @@ Here are the steps to release a beta version of this package depending on its ty
172
183
173
184
2. Enable the pre-release mode by running `yarn changeset pre enter [X]`. `X` is the part after the `/` of your beta branch. Example for `beta/refactor`, X would be `refactor`. This will create a `pre.json` file in `.changesets` that must be pushed on your beta branch.
174
185
175
-
3. Commit and push your related PR's to the newly created branch (step 1).
186
+
3. Commit and push your related PRs to the newly created branch (step 1).
176
187
177
188
4. When a PR is merged onto your beta branch, the [release CI](./.github/workflows/publish.yml) opens a PR named `Version Packages (X)` (see step 2 for `X`). This PR contains all the changesets and the version update based on the type of changes in the changesets.
178
189
179
-
5. To publish the release on Github and `npm`, you need to merge the `Version Packages (X)` PR. This will trigger the publishing.
190
+
5. To publish the release on GitHub and `npm`, you need to merge the `Version Packages (X)` PR. This will trigger the publishing.
**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch)
15
+
16
+
This repository contains clients and plugins to use Meilisearch in third party tools.
17
+
18
+
## Table of Contents <!-- omit in toc -->
19
+
20
+
-[📖 Documentation](#-documentation)
21
+
-[🐱 Plugins](#-plugins)
22
+
-[⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
23
+
24
+
## 📖 Documentation
25
+
26
+
For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://docs.meilisearch.com/).
|[`instant-meilisearch`](./packages/instant-meilisearch)| The search client needed to make Meilisearch work with [instantsearch.js](https://github.com/algolia/instantsearch). |
|[`strapi-plugin-meilisearch`](https://github.com/meilisearch/strapi-plugin-meilisearch)| A plugin to add and synchronize your [Strapi](https://strapi.io/) data on Meilisearch. |
41
+
|[`Firestore-meilisearch`](https://github.com/meilisearch/firestore-meilisearch/)| A plugin to synchronize your [firestore](https://firebase.google.com/docs/firestore) data on Meilisearch. |
42
+
|[`gatsby-plugin-meilisearch`](https://github.com/meilisearch/gatsby-plugin-meilisearch/)| A plugin to index your [Gatsby](https://www.gatsbyjs.com/) content to Meilisearch based on graphQL queries. |
43
+
|[`docs-searchbar.js`](https://github.com/meilisearch/docs-searchbar.js)| A search bar integration for all kinds of documentation. |
44
+
|[`vuepress-plugin-meilisearch`](https://github.com/meilisearch/vuepress-plugin-meilisearch)| A plugin to use docs-searchbar.js as the searchbar of vuepress. |
45
+
|||
46
+
47
+
## ⚙️ Development Workflow and Contributing
48
+
49
+
Any new contribution is more than welcome in this project!
50
+
51
+
If you want to know more about the development workflow or want to contribute, please visit our [contributing guidelines](/CONTRIBUTING.md) for detailed instructions!
52
+
53
+
<hr>
54
+
55
+
**Meilisearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.
Copy file name to clipboardExpand all lines: packages/instant-meilisearch/README.md
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@
25
25
26
26
**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch)
27
27
28
-
This library is a client that establishes communication between your [Meilisearch](https://github.com/meilisearch/meilisearch)instance and[InstantSearch](https://github.com/algolia/instantsearch.js). InstantSearch, an open-source project developed by Algolia, is the tool that renders all the components needed to start searching in your front-end application.
28
+
This library is the search client that you should use to make [Meilisearch](https://github.com/meilisearch/meilisearch)work with[InstantSearch](https://github.com/algolia/instantsearch.js). InstantSearch, an open-source project developed by Algolia, is the tool that renders all the components needed to start searching in your front-end application.
29
29
30
30
Instead of reinventing the wheel, we have opted to reuse the InstantSearch library for our own front-end tooling. We will contribute upstream any improvements that may result from our adoption of InstantSearch.
31
31
@@ -39,6 +39,7 @@ NB: If you don't have any Meilisearch instance running and containing your data,
39
39
40
40
## Table of Contents <!-- omit in toc -->
41
41
42
+
-[📖 Documentation](#-documentation)
42
43
-[🔧 Installation](#-installation)
43
44
-[🎬 Usage](#-usage)
44
45
-[💅 Customization](#-customization)
@@ -47,6 +48,10 @@ NB: If you don't have any Meilisearch instance running and containing your data,
47
48
-[📜 API Resources](#-api-resources)
48
49
-[⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
49
50
51
+
## 📖 Documentation
52
+
53
+
For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://docs.meilisearch.com/).
54
+
50
55
## 🔧 Installation
51
56
52
57
Use `npm` or `yarn` to install `instant-meilisearch`:
0 commit comments