Beaver API Playground

Website | Blog | Docs | Downloads | Mastodon | Reddit

Introduction

Welcome to Beaver's API playground! This project is designed to help you understand how to make calls to Beaver's Data API. It also serves as a JavaScript codebase for learning how to use Axios for these calls. Each feature includes detailed instructions and example request bodies.

Requirements

Before you start, ensure you have the following:

• Node.js 20 or later: Download and install from Node.js official site.
• Yarn: Install via npm with the command npm install -g yarn.
• Beaver Notes 3.3.0 or later: Ensure you have the required version installed. You can download it from the official site.

Getting Started

Setup

Clone the repository to your local machine:

git clone https://github.com/Beaver-Notes/Beaver-API-playground.git
cd Beaver-API-playground

Installing Dependencies

Use the following command to install all necessary dependencies:

yarn

Running the Web Server

To run the web server, use the command:

yarn watch

This will start the server and watch for any changes in your codebase, automatically restarting the server as needed.

Contributing

We welcome contributions! If you have suggestions or improvements, feel free to open an issue or submit a pull request.

Support

For any questions or support, please visit our Docs or join our community on Reddit, Mastodon or Bluesky