@instant-api/recipe-book
TypeScript icon, indicating that this package has built-in type declarations

1.3.1 • Public • Published

Instant Recipes Book API

A CLI to create a small Recipes Book API

This package let you quickly create a small JSON API to

  • Add a recipe
  • List all recipes
  • Update a recipe
  • Delete a recipe
  • List all tags
  • List all recipes for a tag

It uses a single JSON file to store data.

Why ?

The aim of this package is to provide an API for front-end exercices, allowing student to use an API without having to set on up themself.

Who made this ?

Hi ! I'm Etienne, you can follow me on Twitter 😉

Usage

npx @instant-api/recipe-book

Options

  • --port or -p: The port to use
  • --file or -f: The path to the json file used to store data.

Note: By default the file is set to recipe-book-db.json.

npx @instant-api/recipe-book --port 9000 --file recipes.json

If you provide an argument with no name is will be used as the file argument

npx @instant-api/recipe-book --file recipes.json

Readme

Keywords

none

Package Sidebar

Install

npm i @instant-api/recipe-book

Weekly Downloads

0

Version

1.3.1

License

MIT

Unpacked Size

354 kB

Total Files

21

Last publish

Collaborators

  • etienne-dldc