SublimePackages.com

Important notice: The hosted sublimepackages.com has been terminated since Package Control now has a great new website with better features than what I was initially trying to bring with this project.

SublimePackages is a nodejs Web application listing sublime text packages.

Prerequisites

The Web application server requires nodejs >= 0.10.15. Data persistence is achieved through ElasticSearch.

By default, the app server will look for an ElasticSearch server instance running on localhost:9200.

To configure the settings and credentials of an ES server, you can set the following environment variables:

• ELASTICSEARCH_HOST: The ES server host name
• ELASTICSEARCH_PORT: The ES server port
• ELASTICSEARCH_USERNAME: The ES server username (optional)
• ELASTICSEARCH_PASSWORD: The ES server password (optional)

Installation

NodeJS dependencies will be installed running the command below:

$ make install

Setup

Data directory

Be sure to create a data directory at the root of the project installation:

$ mkdir data

This directory MUST be writeable by the system user running the import/sync script.

Import

An import script is provided to import information from existing packages living in Package Control.

Detailled data will be fetched using the Github API, so you need to set the GITHUB_API_TOKEN env var to make it work; eg. if your API token is gsdgg6hg54jh800bjb566:

$ GITHUB_API_TOKEN=gsdgg6hg54jh800bjb566 make import

This script is also used to resync the data:

$ GITHUB_API_TOKEN=gsdgg6hg54jh800bjb566 make sync

Syncing

$ make sync

Indexation

Then data should be indexed for the Web application to work properly:

$ make index

Run

Development:

Be sure to have nodemon installed, then:

$ make dev

Production:

$ make run

Hint: It may be a good idea to use something like forever to ensure the app is always live:

$ npm install forever
$ forever start app.js

Test

$ make test

License

MIT