Giter Site home page Giter Site logo

demo-moma's Introduction

MeiliSearch-Vue

MeiliSearch x MoMA

Slack DOI

In this repository, you will find the front-end interface to search through the Museum Of Modern Art Collection. The search is powered by MeiliSearch, a powerful, fast and open-source search engine easy to use and deploy.

Requirements

Demo

If you want to replicate this demo using your own MeiliSearch instance, you will have to follow these steps:

1. Download and launch MeiliSearch

Download and launch MeiliSearch using the basic configuration. For example, by using cURL in your terminal.

$ curl -L https://install.meilisearch.com | sh

$ ./meilisearch

This walkthrough runs MeiliSearch in a development environment, and therefore it does not use any master key.

There are many other easy ways to download and run a MeiliSearch instance.

2. Set your credentials

Set the credentials of the MeiliSearch instance as environment variables.

VUE_APP_MEILISEARCH_HOST="yourMeiliSearchInstanceAddress"
VUE_APP_MEILISEARCH_API_KEY="yourMeiliSearchAPIKey"

Because we did not set any Master key in the previous step, we can leave VUE_APP_MEILISEARCH_API_KEY as an empty string and only set the host: VUE_APP_MEILISEARCH_HOST='http://127.0.0.1:7700'

3. Donwload the dataset:

You can download the dataset by running the following commands:

$ npm install

$ npm run get-dataset

Or you can get it manually in the MoMA repository and copy it in the setup folder.

4. Run the setup

$ npm run prep-meili

Don't forget to run $ npm install first, if you didn't do it in the previous step.

This will do the following:

  • Create three indexes called artWorks, artWorksAsc and artWorksDesc in your MeiliSearch instance.

  • Add all artworks documents to those indexes.

  • Add custom settings to each one for a more relevant search.

5. Run the project

You can now run the project. The front-end client is now communicating with your MeiliSearch instance.

$ npm run serve

Visit http://localhost:8080/ in your browser and start searching with MeiliSearch!


MeiliSearch provides and maintains many SDKs and Integration tools like the ones used in this project. 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 repository.

demo-moma's People

Contributors

carofg avatar dependabot-preview[bot] avatar dependabot[bot] avatar eskombro avatar ferdi05 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.