Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/jgantunes/docerita-algolia-index

https://github.com/jgantunes/docerita-algolia-index

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.0%) to scientific vocabulary
Last synced: 4 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: JGAntunes
  • License: mit
  • Language: JavaScript
  • Default Branch: master
  • Size: 894 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 4 years ago · Last pushed over 4 years ago
Metadata Files
Readme License

README.md

Ghost Algolia tools

Ghost Algolia tools offers tools to index and fragment Ghost posts to an Algolia index. It consists of two user facing tools:

  • algolia, which is a CLI tool to batch index the full content of a Ghost install to a defined Algolia index
  • algolia-netlify, which uses Netlify Functions to listen to Ghost webhooks and add, update, and remove posts to an Algolia index

Usage

Algolia Netlify package

You can start using the Algolia Netlify package by clicking on this deplooy button. You can find the detailed install and user instructions over here.

Deploy to Netlify

Ghost Algolia CLI

While the Algolia Netlify tool is useful to maintain your search index, the Ghost Algolia CLI is good for the initial indexing of the full post content of a site. See full install und user instructions in the package description here.

Develop

This is a mono repository, managed with lerna.

  1. git clone this repo & cd into it as usual
  2. yarn setup is mapped to lerna bootstrap
    • installs all external dependencies
    • links all internal dependencies

To add a new package to the repo: - install slimer - run slimer new <package name>

Run

  • yarn dev

Test

  • yarn lint run just eslint
  • yarn test run lint and tests

Publish

  • yarn ship is an alias for lerna publish
    • Publishes all packages which have changed
    • Also updates any packages which depend on changed packages

Copyright & License

Copyright (c) 2013-2021 Ghost Foundation - Released under the MIT license.

Owner

  • Name: João Antunes
  • Login: JGAntunes
  • Kind: user
  • Location: Lisbon
  • Company: @netlify

GitHub Events

Total
Last Year

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 66
  • Total Committers: 5
  • Avg Commits per committer: 13.2
  • Development Distribution Score (DDS): 0.061
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Aileen Nowak A****N@g****m 62
Renovate Bot b****t@r****m 1
Paul Davis P****s 1
John O'Nolan j****n@o****g 1
Hannah Wolfe e****s@g****m 1
Committer Domains (Top 20 + Academic)
onolan.org: 1 renovateapp.com: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/test.yml actions
  • actions/checkout v1 composite
  • actions/setup-node v1 composite
package.json npm
  • eslint 7.27.0 development
  • eslint-plugin-ghost 2.2.0 development
  • mocha 7.1.2 development
  • should 13.2.3 development
  • sinon 9.0.2 development
packages/algolia/package.json npm
  • mocha 7.1.2 development
  • should 13.2.3 development
  • sinon 9.0.2 development
  • @tryghost/algolia-fragmenter ^0.2.1
  • @tryghost/content-api 1.5.6
  • @tryghost/pretty-cli 1.2.17
  • fs-extra 10.0.0
packages/algolia-fragmenter/package.json npm
  • mocha 7.1.2 development
  • should 13.2.3 development
  • sinon 9.0.2 development
  • algolia-html-extractor 0.0.1
packages/algolia-indexer/package.json npm
  • mocha 7.1.2 development
  • should 13.2.3 development
  • sinon 9.0.2 development
  • algoliasearch 4.9.1
packages/algolia-netlify/package.json npm
  • eslint 7.27.0 development
  • eslint-config-airbnb-base 14.2.1 development
  • eslint-plugin-ghost 2.2.0 development
  • eslint-plugin-import 2.23.3 development
  • mocha 7.1.2 development
  • should 13.2.3 development
  • sinon 9.0.2 development
  • @tryghost/algolia-fragmenter ^0.2.1
  • @tryghost/algolia-indexer ^0.1.5
  • dotenv-webpack 7.0.2
  • netlify-lambda 2.0.7
  • webpack 5.37.1
yarn.lock npm
  • 995 dependencies