BrewBuddy API: Automate Your Coffee Experience!
This website provides comprehensive documentation for the BrewBuddy API, built using Docusaurus, a modern static website generator. You can dive right into the API Docs to learn more!
Installation & Local Development
Installation
To set up the project locally, first install the dependencies:
npm install
# or yarn install
Local Development
This command starts a local development server and opens a browser window. Most changes are reflected live without having to restart the server.
npm start
# or yarn start
Build & Deployment
Build
This command generates static content into the build directory and can be served using any static content hosting service.
npm run build
# or yarn build
Deployment
If you are using GitHub Pages for hosting (which you are!), your configured GitHub Actions workflow handles the deployment automatically on push to main.
Key API Endpoints Overview
This is a GFM table to showcase common API endpoints.
| Endpoint | Method | Description | Authentication Required |
|---|---|---|---|
/v1/status | GET | Get current machine status | No |
/v1/brew | POST | Start a brewing cycle | Yes |
/v1/profiles | GET | List all available brew profiles | No |
/v1/profiles/{id} | PUT | Update a specific brew profile | Yes |
/v1/maintenance/clean | POST | Initiate a cleaning cycle | Yes |
/v1/telemetry | GET | Fetch real-time telemetry data | Yes |
Project Status (GFM Task List Example)
This is a GFM task list to track project progress.
- Initial Docusaurus setup
- Basic documentation content added
- GitHub Pages deployment via Actions
- Implement custom homepage (this task is in progress!)
- Add more API reference documentation
- Integrate Swagger/OpenAPI spec (future)
- Create troubleshooting guide
This README uses GitHub Flavored Markdown (GFM) for tables and task lists, while admonitions (such as this message) use Docusaurus-exclusive syntax.