meilisearch / musicbrainz-demo

A demo showcasing Meilisearch with a large musics dataset coming from Musicbrainz

MusicBrainz Demo

Website | Meilisearch Cloud | Blog | Documentation | Discord

Meilisearch is an open-source search engine that offers fast, relevant search out of the box.

Table of Contents:

• Setup
• Run
• Build
  • Generate build
  • Specify Meilisearch's server URL
  • Run your build
• Storybook
• Contributing

Setup

yarn

Run

yarn start

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

Build

Generate build

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

yarn build

Specify Meilisearch's server URL

⚠️ By default, the application will call Meilisearch at the exact same address as it is running. Example: if your app is running at http://localhost:5000, it will try to call http://localhost:5000/indexes to retrieve the list of your indexes.

If you want to specify the URL where your Meilisearch is running, use the REACT_APP_MEILI_SERVER_ADDRESS environment variable.

Example:

REACT_APP_MEILI_SERVER_ADDRESS=http://0.0.0.0:7700 REACT_APP_MEILI_API_KEY=xxx yarn build

Run your build

The above commands will generate an optimized version of the app, inside the build folder.

You can then serve it with any web server of your choice.

Example:

serve build

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

Contributing

If you want to contribute to this project, please make sure to read the contributing guidelines

Compatibility with Meilisearch

This package guarantees compatibility with version v1.x of Meilisearch, but some features may not be present. Please check the issues for more info.