https://github.com/adbertram/brickbuddy-api-docs
https://github.com/adbertram/brickbuddy-api-docs
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/adbertram/brickbuddy-api-docs
- Owner: adbertram
- Created: 2025-04-21T12:54:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-21T14:19:44.000Z (over 1 year ago)
- Last Synced: 2025-05-03T14:55:56.463Z (about 1 year ago)
- Language: JavaScript
- Size: 190 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BrickBuddy API Documentation Portal
A comprehensive documentation and interactive testing portal for the BrickBuddy API.
## Overview
The BrickBuddy API Documentation Portal provides a complete reference guide and interactive playground for developers working with the BrickBuddy API. This portal is designed to help you understand, explore, and test all available API endpoints for managin inventories.
## Setup
1. Install dependencies:
```
npm install
```
2. Run the development server:
```
npm run dev
```
This will start both the Express backend server and the React frontend development server concurrently.
## Features
- **Complete API Reference**: Detailed documentation for all BrickBuddy API endpoints
- **Interactive Testing**: Try API endpoints directly from the browser with a user-friendly interface
- **Code Examples**: Ready-to-use code samples for common operations
- **Response Visualization**: View API responses in a structured, easy-to-read format
- **Resource Explanations**: Clear descriptions of all API resources and their relationships
## Documented Resources
- **Items**: Pieces with their properties and metadata
- **Lots**: Specific item and color combinations with market pricing
- **Inventory**: Physical inventory tracking and management
- **Sets**: Complete sets with their contents
- **Orders**: Customer purchase management
- **Colors**: Color information and references
## Tech Stack
- React for the frontend
- Express for the backend
- Tailwind CSS for styling
## About BrickBuddy API
The BrickBuddy API provides comprehensive tools for managing collections, tracking inventory, monitoring market prices, and more. For API access and account information, visit [brickbuddy.com](https://brickbuddy.com).