soulheart

KO | EN

gitlite — search

#python #hacktoberfest #typescript #go #rust #deep-learning #linux #macos #windows #awesome #pytorch #security #mcp #ios

(★ 74)

Easy autocomplete: redis, ruby, :heart:

파일 탐색기

최종 버전 다운로드 (.zip)

- soulheart
- soulheart-web
- categories.json
- emoticons.tsv
- logo.png
- manufacturers.tsv
- manufacturers_simple.tsv
- screenshot.png
- - base.rb
  - config.rb
  - helpers.rb
  - loader.rb
  - matcher.rb
  - server.rb
  - version.rb
- soulheart.rb
- - .keep
- - multiple_categories.json
- - helpers_spec.rb
  - loader_spec.rb
  - matcher_spec.rb
  - server_spec.rb
- soulheart_spec.rb
- spec_helper.rb
.gitignore
.rspec
.travis.yml
app.json
config.ru
Gemfile
Gemfile.lock
Guardfile
LICENSE.md
Rakefile
README.md
soulheart.gemspec

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# <img src="https://raw.githubusercontent.com/sethherr/soulheart/master/examples/logo.png" alt="Soulheart" width="200"> Soulheart [![Build Status](https://travis-ci.org/sethherr/soulheart.svg?branch=master)](https://travis-ci.org/sethherr/soulheart) [![Code Climate](https://codeclimate.com/github/sethherr/soulheart/badges/gpa.svg)](https://codeclimate.com/github/sethherr/soulheart) [![Test Coverage](https://codeclimate.com/github/sethherr/soulheart/badges/coverage.svg)](https://codeclimate.com/github/sethherr/soulheart/coverage)

Soulheart is a ready-to-use remote data source for autocomplete. The goal is to provide a solid, flexible tool that's downright easy to set up and use.

- [Intro page](https://sethherr.github.io/soulheart/)
- [Usage documentation (commands)](https://sethherr.github.io/soulheart/commands/)
- [Example data sources](https://github.com/sethherr/soulheart/tree/master/examples)
- [Getting started](#getting-started)
- [Deployment](#deployment)
- [Testing](#testing)
- Example usage [with Selectize](https://sethherr.github.io/soulheart/examples_selectize) & [Select2](https://sethherr.github.io/soulheart/examples_select2)

## Features

- **Pagination**
 For infinite scrolling of results - wow!
- **Categories**
 Match results for specified categories, or not. Your choice
- **Prioritization**
 Return results sorted by priority (not just alphabetically)
- **Arbitrary return objects**
 Get whatever you want back. IDs, URLs, image links, HTML, :boom:
- **Loads data**
 Accepts local or remote data - e.g. you can use a [gist](https://github.com/sethherr/soulheart/blob/master/examples/manufacturers.tsv)
- **Runs Standalone or inside a rails app**

[![Autocomplete in action](https://github.com/sethherr/soulheart/raw/master/examples/screenshot.png)](https://sethherr.github.io/soulheart/)

## Getting started

See the [Soulheart intro page](https://sethherr.github.io/soulheart/) for a step-by-step explanation of setting up a select box that uses Soulheart as a remote data source.

## Deployment

#### With Heroku [![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)

**You can instantly deploy Soulheart to Heroku for free!** This requires a verified Heroku account&mdash;you will have to add a payment method to Heroku but you won't be charged.

To update your Heroku deploy of Soulheart, use the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-command) and redeploy the app: 
  
    heroku deploy -a NAME_OF_YOUR_APP_ON_HEROKU

## In a Rails app

Soulheart is a gem. It uses [hiredis](https://github.com/redis/hiredis) on Ruby MRI. Add these lines to your gemfile:

gem 'soulheart'
    gem 'hiredis', '~> 0.6.0' # Skip using JRuby
    gem 'redis', '>= 3.2.0', require: ['redis', 'redis/connection/hiredis'] # Skip if using JRuby

And add this in your routes.rb:

require 'soulheart/server'

Rails.application.routes.draw do
      # .... your application routes

mount Soulheart::Server => '/soulhearts'
    end

You can then access the server when your rails app is running. You can run the [Soulheart commands](https://sethherr.github.io/soulheart/commands/) from that directory.

*Hote: On Heroku Soulheart uses `rackup` to start the server. Because of this, there's a `config.ru`, a `Gemfile.lock` and a `app.json`&mdash;to make it (and any forks of it) directly deployable. These files aren't in the Gem.*

##### Setting redis url

You can also set the redis url.

```ruby
# config/initializers/soulheart.rb

Soulheart.redis = 'redis://127.0.0.1:6379/0'
# or you can asign an existing instance of Redis, Redis::Namespace, etc.
# Soulheart.redis = $redis
```
## Testing

Tested with rspec. Check out test information at [Code Climate](https://codeclimate.com/github/sethherr/soulheart).

You can run `bundle exec guard` to watch for changes and rerun the tests when files are saved.

## Requirements

Soulheart is a Redis backed Sinatra server. It's tested with the latest MRI (2.2, 2.1, 2.0) and JRuby versions (1.7). Other versions/VMs are untested but might work fine.

It requires Redis >= 3.0

## Additional info

This initially started as a fork of [Soulmate](https://github.com/seatgeek/soulmate) to support the features listed, provide demos and make it instantly deployable to Heroku.

It's MIT licensed.

soulheart

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

soulheart

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README