edgeking8100/kinesis-api repository overview

⁠Kinesis API

Kinesis API is a powerful, all-in-one API development and management platform designed for modern teams. It provides a robust backend engine, a user-friendly web interface, and a comprehensive set of features for building, documenting, and managing APIs, data, tickets, blogs, localization, and more.

⁠Features

• Modern API Framework: Rapidly build, deploy, and manage APIs with a flexible, modular architecture.
• Integrated Web Portal: Manage collections, data, users, tickets, blog posts, and more through a beautiful UI.
• Rich Data Modeling: Support for custom structures, constraints, and relationships.
• Built-in Ticketing System: Track bugs, feature requests, and feedback with advanced permissions and workflows.
• Blog System: Publish articles, documentation, and updates with Markdown support and interactive comments.
• Localization: Easily translate your app and content into multiple languages.
• Authentication & Security: Role-based access control, personal access tokens, and optional 2FA.
• Metrics & Monitoring: Prometheus-compatible metrics and real-time event logging.
• OpenAPI/Swagger Docs: Auto-generated, interactive API documentation.
• Extensible: Easily integrate with external systems and customize to your needs.

⁠Getting Started

⁠Pull the Image

docker pull edgeking8100/kinesis-api:latest

⁠Run the Container

mkdir -p data/ public/ translations/

echo "TMP_PASSWORD=yourSecurePassword" > .env
echo "API_URL=http://localhost:8080" >> .env

docker run --name kinesis-api \
  -v $(pwd)/.env:/app/.env \
  -v $(pwd)/data:/app/data \
  -v $(pwd)/public:/app/public \
  -v $(pwd)/translations:/app/translations \
  -p 8080:8080 -d \
  --restart unless-stopped \
  edgeking8100/kinesis-api:latest

• The web portal will be available at http://localhost:8080/web
• API endpoints are available at http://localhost:8080

⁠Configuration

• Environment variables can be set to customize database, authentication, and other settings.
• See the documentation⁠ for details on configuration options.

⁠Volumes

• /app/data: Persistent storage for your database files.
• /app/public: Persistent storage for uploaded media files.
• /app/translations: Persistent storage for localization files.

⁠Documentation

• Full Documentation⁠
• API Reference⁠

Build, manage, and scale your APIs with confidence using Kinesis API!