Skip to content

Latest commit

 

History

History
26 lines (24 loc) · 1.1 KB

README.md

File metadata and controls

26 lines (24 loc) · 1.1 KB

Documentation TOC

  • Using frock in your project/Understanding Packages is an overview of how frock is meant to sit alongside your project.
  • Implementing mocks/fakes:
    • Plugins: writing plugins, where you'll implement your fake services.
    • Middleware: writing middleware, which can augment your plugins' functionality.
    • Cores: writing cores, which can extend the core functionality of frock.
  • frockfile Reference, which explains the configuration file format that frock uses, the frockfile.json
  • Examples which provides detailed examples of using frock, and can help you understand how to implement your fake services.
  • API details the frock API, which can be used programatically rather than via the provided CLI. This also documents the frock singleton your plugins will be passed when they are instantiated.