Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/tqn/findex

Crawls a directory you give it to to search for .url files, then indexes those URLs into elasticsearch
https://github.com/tqn/findex

Last synced: about 2 months ago
JSON representation

Crawls a directory you give it to to search for .url files, then indexes those URLs into elasticsearch

Awesome Lists containing this project

README

        

# findex

[![GitHub release](https://img.shields.io/github/release/tqn/findex.svg?style=flat-square)](https://github.com/tqn/findex/releases/latest)
[![Travis](https://img.shields.io/travis/tqn/findex.svg?style=flat-square&branch=master)](https://travis-ci.org/tqn/findex)
[![Code Climate](https://img.shields.io/codeclimate/github/tqn/findex.svg?style=flat-square)](https://codeclimate.com/github/tqn/findex)
[![Coveralls](https://img.shields.io/coveralls/tqn/findex.svg?style=flat-square)](https://coveralls.io/github/tqn/findex)
[![David](https://img.shields.io/david/tqn/findex.svg?style=flat-square)](https://david-dm.org/tqn/findex#info=dependencies)
[![David](https://img.shields.io/david/dev/tqn/findex.svg?style=flat-square)](https://david-dm.org/tqn/findex#info=devDependencies)

Crawls a directory you give it to to search for `.url` files, then indexes those URLs into [Elasticsearch](https://www.elastic.co/products/elasticsearch).

## Setup
1. Install this package globally with `npm i -g tqn/findex#[VERSION TAG]`.
2. Invoke with `findex`

### To Configure
1. Run `findex --config` to find the location of the configuration file.
2. Edit the file.

## Todo
- [ ] Increase coverage.