Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/contributte/demo-typesense

🏀 Demo application of Typesense (@typesense) based on Nette Framework (@nette) by @f3l1x.
https://github.com/contributte/demo-typesense

contributte demo engine nette project search skeleton typesense

Last synced: 27 days ago
JSON representation

🏀 Demo application of Typesense (@typesense) based on Nette Framework (@nette) by @f3l1x.

Awesome Lists containing this project

README

        

![](https://heatbadger.now.sh/github/readme/contributte/demo-typesense/)













Website 🚀 contributte.org | Contact 👨🏻‍💻 f3l1x.io | Twitter 🐦 @contributte

----

![](.docs/screenshot.png)

-----

## Goal

Demo of [Typesense](https://typesense.org/) Search Engine to Nette ([@nette](https://github.com/nette)) by [@f3l1x](https://github.com/f3l1x).

## Installation

You will need `PHP 8.2+` and [Composer](https://getcomposer.org/).

Create project using composer.

```bash
composer create-project -s dev contributte/demo-typesense acme
```

Now you have application installed. It's time to run it.

## Startup

1. Spin up PostgreSQL database. It will load `init.sql` file, thus you don't have to create schema manually.

```bash
docker compose up
```

2. Prepare search engine structure in Typesense.

```bash
bin/setup
```

3. Prepare fake data in PostgreSQL (optional).

```bash
bin/fake
```

4. Start PHP built-in web server.

```bash
bin/dev
# or
php -S 0.0.0.0:8000 -t www
```

Then visit [http://localhost:8000](http://localhost:8000) in your browser.

## Development

See [how to contribute](https://contributte.org/contributing.html) to this package.

This package is currently maintaining by these authors.



-----

Consider to [support](https://contributte.org/partners.html) **contributte** development team.
Also thank you for using this project.