https://github.com/beaver-notes/beaver-api-playground
Beaver's Data API Playground
https://github.com/beaver-notes/beaver-api-playground
api beaver-notes playground
Last synced: 2 months ago
JSON representation
Beaver's Data API Playground
- Host: GitHub
- URL: https://github.com/beaver-notes/beaver-api-playground
- Owner: Beaver-Notes
- License: mit
- Created: 2024-05-31T07:27:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-13T19:24:12.000Z (over 1 year ago)
- Last Synced: 2025-01-19T13:52:50.681Z (about 1 year ago)
- Topics: api, beaver-notes, playground
- Language: Vue
- Homepage: https://beaver-notes.github.io/Beaver-Docs/docs/dev-docs/Beaver%20Notes/Integations
- Size: 21.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Beaver API Playground
[Website](https://beavernotes.com) | [Blog](https://beavernotes.com/blog) | [Docs](https://danieles-organization.gitbook.io/beaver-notes/) | [Downloads](https://beavernotes.com/download) | [Mastodon](https://mastodon.social/@Beavernotes) | [Reddit](https://www.reddit.com/r/BeaverNotes/)
## 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](https://nodejs.org/).
- **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](https://beavernotes.com/download).
## Getting Started
### Setup
Clone the repository to your local machine:
```sh
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:
```sh
yarn
```
### Running the Web Server
To run the web server, use the command:
```sh
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](https://beaver-notes.github.io/Beaver-Docs/docs/dev-docs/Beaver%20Notes/Integations) or join our community on [Reddit](https://www.reddit.com/r/BeaverNotes/), [Mastodon](https://mastodon.social/@Beavernotes) or [Bluesky](https://bsky.app/profile/beavernotes.bsky.social)