Skip to content

varunsingh87/GreenboardAudio-API

Repository files navigation

Flytrap API

The Flytrap API is the new REST API for Flytrap. Flytrap is an audio cloud service. You make HTTP requests to Flytrap API endpoints and receive a JSON response, documented on the Borum Developer Docs.

Usage

To use the Flytrap API, go to https://api.audio.borumtech.com. The documentation is on the Borum Developer Docs and on SwaggerHub

Installation (Prerequisites)

  1. Install and make sure PHP is configured

  2. Run the command php -s localhost:8100 to start the server and open any endpoint in your browser

Built With

I use the following tools to develop, test, and deploy the Flytrap API:

  • NPM - Package Management System for runtime
  • composer - Package Management System for development
  • VSCode - Code editor for development
  • Vercel - hosting platform
  • vercel-php - Runtime for PHP to deploy on Vercel
  • PHP Sleep - PHP library for generic REST API code
  • PHP - language for developing REST API

License

This project uses the MIT Open Source License

Contributing

Thanks for considering contributing to the Flytrap API! I value all feature requests, bug fixes, questions, and documentation feedback. To begin contributing, read the Contributing Guide.