scallion-wiki-api

Description

Wiki API server built on top of GemStone/S

Details

Source
GitHub
Dialect
gemstone (65% confidence)
License
MIT
Stars
2
Created
Feb. 14, 2023
Updated
July 18, 2023
Topics
gemstone smalltalk wiki

Categories

Serialization

README excerpt

# scallion-wiki-api
Wiki API server built on top of GemStone/S.

## Installation

First, you should install [gsApplicationTools](https://github.com/GsDevKit/gsApplicationTools).

Just install and load the latest ZincHTTPComponents from your tODE shell. This will also load gsApplicationTools.
```
> project install
 --url=http://gsdevkit.github.io/GsDevKit_home/ZincHTTPComponents.ston
> project load ZincHTTPComponents
```

Then, from the tODE shell:
```
> project entry --baseline=ScWikiApi --repo=github://mumez/scallion-wiki-api:main/repository /sys/local/server/projects
> project load ScWikiApi
```

After loading, please register ports and delegate from Workspace.

```smalltalk
ZnNewGemServer register: 'zinc' on: #(9089 9088 9087 9086).
(GemServer gemServerNamed: 'zinc') delegate: ScWikiApi new.
```

Now you can start wiki server

```smalltalk
(GemServer gemServerNamed: 'zinc') restartGems.
```

## API

Draft API document is [here](https://softumeya-llc.stoplight.io/docs/scallion-wiki-api/branches/main/3tx0q260z82ve-scallion-wiki-api)

### Search API

If you would like to use the search API, please set up [Meilisearch.st](https://github.com/mumez/Meilisearch.st) as well.

You can disable the feature by evaluating:

```smalltalk
ScSettings default useSearchEngine: false.
```

## Demo

Example frontend: [scallion-svelte](https://github.com/mumez/scallion-svelte) is running [here](https://scallion-svelte.vercel.app/)
← Back to results