Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/meilisearch/saas-demo

App search in a CRM use case, powered by Meilisearch
https://github.com/meilisearch/saas-demo

crm laravel meilisearch search-engine

Last synced: about 2 months ago
JSON representation

App search in a CRM use case, powered by Meilisearch

Lists

README

        



Meilisearch

Meilisearch SaaS demo


Website |
Meilisearch Cloud |
Blog |
Documentation |
Discord

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

## 💪 Looking to build this yourself?

Read our [Complete guide to full-text search with Laravel](https://blog.meilisearch.com/laravel-full-text-search/?utm_campaign=saas-demo&utm_source=github&utm_medium=readme)!

## ✨ Features

This SaaS demo uses the following:

- [Multi-search](https://www.meilisearch.com/docs/reference/api/multi_search?utm_campaign=saas-demo&utm_source=github&utm_medium=readme) (search across multiple indexes)
- [Multi-tenancy](https://www.meilisearch.com/docs/learn/security/tenant_tokens?utm_campaign=saas-demo&utm_source=github&utm_medium=readme)
- [Filtering](https://www.meilisearch.com/docs/learn/fine_tuning_results/filtering?utm_campaign=saas-demo&utm_source=github&utm_medium=readme)
- [Sorting](https://www.meilisearch.com/docs/learn/fine_tuning_results/sorting?utm_campaign=saas-demo&utm_source=github&utm_medium=readme)

## 🧰 Stack

This project uses:

- [PHP 8.2](https://www.php.net/)
- [Laravel 10](https://laravel.com/)
- [TailwindCSS 3](https://tailwindcss.com/) and [HyperUI](https://www.hyperui.dev/) components
- [Heroicons 2](https://heroicons.com/) and social medias icons from [icons8](https://icons8.com/icons/collections/EnE9mEHAiX2D)
- [Meilisearch](https://www.meilisearch.com/?utm_campaign=saas-demo&utm_source=github&utm_medium=readme) for fast, relevant search
## 🧑‍💻 Development

This project uses [Sail](https://laravel.com/docs/10.x/sail) for local development using Docker.

> Make sure to follow the Sail documentation and prefix commands accordingly to be able to run them in Docker.

### Installation

Install PHP dependencies:

```sh
composer install
```

Install Node dependencies:

```sh
sail yarn
```

Launch Docker services for local development:

```sh
sail up
```

Run JavaScript dev server:

```sh
sail yarn dev
```

## 🛠️ Setup

Copy `.env.example` as `.env` and update environment variables as needed.

### Using Meilisearch with Laravel Sail

When running Meilisearch through Sail, your `MEILISEARCH_HOST` should follow the `http://meilisearch:port` form (instead of `localhost:port`.) However, your front-end application expect the real URL to your Meilisearch instant.

This means that when running Meilisearch locally with Sail, your `.env` file will look like:

```sh
# This is the URL used by Laravel to access Meilisearch
MEILISEARCH_HOST=http://meilisearch:7700

# This is the URL used by JavaScript to access Meilisearch
VITE_MEILISEARCH_HOST=http://localhost:7700
```

> See [Sail documentation](https://laravel.com/docs/10.x/sail#meilisearch).

### Instructions

Setup your Meilisearch settings by running:

```sh
artisan scout:sync-index-settings
```

Seed the database:

```sh
artisan migrate:fresh --seed
```

## Conventions

This project uses the [Blade Formatter](https://marketplace.visualstudio.com/items?itemName=shufo.vscode-blade-formatter) VS code extension to format `.blade.php` files.