Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.93 KB

README.md

File metadata and controls

50 lines (33 loc) · 1.93 KB
Raw

tinylicious

Tinylicious is a minimal, self-contained, test implementation of the Fluid Framework service that is much smaller (tinier!) than Routerlicious, our reference implementation of the service.

What is this for?

Tinylicious includes most of the basic features needed to test data stores and containers. While we use the Local Server as an in-browser service for much of our data store and container development, Tinylicious offers some advantages because it's a standalone process. For instance, testing a Fluid Container from 2+ simultaneously connected clients can be easier using Tinylicious.

If you're looking for a reference implementation of the Fluid service, don't look here! Go check out Routerlicious.

Getting Started

You can build this service by running the following in the /server/routerlicious directory (NOT in this directory):

npm i -g pnpm
pnpm i
pnpm build

Afterwards, you can start and stop this service with the following commands in this directory:

pnpm start
pnpm stop

Configuration

Port

Tinylicious uses port 7070 by default. You can change the port number by setting an environment variable named PORT to the desired number. For example:

$env:PORT=6502
pnpm start

Storage

The config.json file can be used to configure the Tinylicious service.

Parameter Description Default
db.inMemory Boolean indicating whether ops are stored in memory or to disk true
db.path If db.inMemory is false the folder on disk to store the ops "/var/tmp/db"
storage Storage path for snapshots "/var/tmp/tinylicious"

See config.json for more settings and their defaults.