Code Monkey home page Code Monkey logo

fist's Introduction

Fist - (F)ull-(t)ext (i)ndex (s)erver

Slack Patreon CircleCI

Fist is a fast, lightweight, full-text search and index server. Fist stores all information in memory making lookups very fast while also persisting the index to disk. The index can be accessed over a TCP connection and all data returned is valid JSON.

Fist is still heavily under development. Not all features are implemented or stable yet.

Motivation

Most software that requires full-text search is not really that complicated and does not need an overly complex solution. Using a complex solution often times leads to headaches. Setting up Elasticsearch when Elasticsearch really isn't needed for the particular application costs more time and money to maintain.

This is where Fist comes in. Fist is intended to be extremely easy to deploy and integrate into your application. Just start the Fist server and start sending commands.

Build and start Fist server

make
./bin/fist
Fist started at localhost:5575

Run Tests

make test

Example Usage

Commands can be sent over a TELNET connection

Commands: INDEX, SEARCH, EXIT, VERSION

telnet localhost 5575
Trying ::1...
telnet: connect to address ::1: Connection refused
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
INDEX document_1 Some text that I want to index
Text has been indexed
INDEX document_2 Some other text that I want to index
Text has been indexed
SEARCH I want to index
["document_1","document_2"]
EXIT
Bye

Docker Usage

# Build image
docker build . -t fist:latest

# Run tests
docker run --rm -it fist test

# Run server and make volume for database
docker run -d --init --rm -p 5575:5575 -v /var/local/lib/fist fist

Key Features

  • Full text indexing and searching
  • Persisting data to disk
  • Compression of index file
  • Accessible over TCP connection

Client Libraries

NodeJS

Python

Go

Contributors

fist's People

Contributors

00-matt avatar 0xflotus avatar andrerenaud avatar f-prime avatar stefanslehta avatar wanghenshui 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.