https://github.com/adbertram/brickbuddy-api
https://github.com/adbertram/brickbuddy-api
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/adbertram/brickbuddy-api
- Owner: adbertram
- Created: 2025-04-26T14:46:53.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-27T16:52:55.000Z (about 1 year ago)
- Last Synced: 2026-03-30T01:21:27.686Z (4 months ago)
- Language: JavaScript
- Size: 163 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BrickBuddy API Docs Demo
> **Demo project for the Pluralsight course _"Creating Developer Documentation with GitHub Copilot"_**
---
## Overview
This project demonstrates how to document and test a simple API using modern developer tools. It features a Node.js/Express backend and a React-based frontend for interactive API exploration. All data and endpoints are mock/demo only.
---
## Quick Start
```bash
# Install dependencies
npm install
# Start the backend server
npm start
```
The server will run on [http://localhost:5001](http://localhost:5001) by default.
---
## API Usage Example
**Endpoint:**
```
GET /api/piece-destinations?lot_id=YOUR_LOT_ID
```
**Query Parameters:**
- `lot_id` (required): The ID of the lot to fetch destinations for.
**Sample Response:**
```json
{
"set_destinations": [
{ "name": "Demo Set 1", "number": "75300-1", ... },
{ "name": "Demo Set 2", "number": "10281-1", ... }
],
"part_destinations": [
{ "recommended": true, "user_inventory_item_location_name": "Parts Drawer 5", ... },
{ "recommended": false, "user_inventory_item_location_name": "Bulk Parts Tub", ... }
]
}
```
## Notes
- This project is for demonstration and educational purposes only. All data is mock data.
- For OpenAPI integration, place your OpenAPI YAML files in an `openapi/` directory at the project root.
---
## License
MIT