Where to Watch

MeiliSearch | Documentation | Slack | Website | FAQ

Where to Watch

Table of Contents:

• Setup
  • Install dependencies
  • Run Meilisearch
  • Import movies
• Run
• Build
  • Generate build
  • Run your build
• Environment variables
• Compatibility with Meilisearch
• Storybook

Setup

Install dependencies

yarn

Run Meilisearch

You can run a Meilisearch instance locally with the following command:

docker run -it --rm \
    -p 7700:7700 \
    getmeili/meilisearch:latest \
    meilisearch --env="development"

Import movies

Run the following script to create the different indexes and upload the movies documents:

You need to run this command at least once to create the correct indexing settings: yarn setup:settings

Then run the setup to index the data: yarn setup

Run

yarn dev

Go to http://localhost:3000/ and enjoy! 🎉

Build

Generate build

You can generate a build of this project with the following command:

yarn build

Run your build

You can serve the generated build with:

yarn start

Or serve it with any web server of your choice.

Example:

serve .next

Environment variables

To connect to your own Meilisearch instance, two environment variables should be provided:

• MEILISEARCH_HOST: the URL of your Meilisearch instance
• MEILISEARCH_API_KEY: an API key with at least search rights

You can copy the existing .env.example file as .env and update the values accordingly.

Compatibility with Meilisearch

This demo only guarantees compatibility with Meilisearch versions ≥ 1.13.

Storybook

Storybook is a development environment for UI components. It allows you to browse a component library, view the different states of each component, and interactively test components.

yarn storybook

Testing

Tests are implemented using Cypress. To run the tests, first launch a Meilisearch instance, then run:

yarn test

Environment variables

Environment variables are configured in cypress.config.js:

const { defineConfig } = require('cypress')

module.exports = defineConfig({
  // ...
  env: {
      MEILISEARCH_HOST: 'http://0.0.0.0:7700',
      MEILISEARCH_API_KEY: 'masterKey',
    }
}