{"id":49881363,"url":"https://github.com/imdeepmind/rocket","last_synced_at":"2026-05-15T14:37:04.214Z","repository":{"id":347785123,"uuid":"1195234644","full_name":"imdeepmind/rocket","owner":"imdeepmind","description":"Rocket is a configuration-driven API framework designed to create APIs, manage databases.","archived":false,"fork":false,"pushed_at":"2026-05-02T17:33:56.000Z","size":877,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"develop","last_synced_at":"2026-05-02T19:24:15.345Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://rocket.imdeepmind.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/imdeepmind.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-29T12:14:41.000Z","updated_at":"2026-04-25T16:01:27.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/imdeepmind/rocket","commit_stats":null,"previous_names":["imdeepmind/rocket"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/imdeepmind/rocket","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imdeepmind%2Frocket","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imdeepmind%2Frocket/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imdeepmind%2Frocket/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imdeepmind%2Frocket/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imdeepmind","download_url":"https://codeload.github.com/imdeepmind/rocket/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imdeepmind%2Frocket/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33070211,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-15T11:35:32.926Z","status":"ssl_error","status_checked_at":"2026-05-15T11:35:31.362Z","response_time":103,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-05-15T14:37:03.279Z","updated_at":"2026-05-15T14:37:04.197Z","avatar_url":"https://github.com/imdeepmind.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rocket OSS\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/logo.png\" alt=\"Rocket API Framework Logo\" width=\"200\" /\u003e\n\u003c/p\u003e\n\nRocket is a configuration-driven API framework designed to accelerate backend development by automating standard engineering tasks. By defining models in a structured JSON format, Rocket automatically handles database schema generation, RESTful routing, request validation, and interactive documentation.\n\n## Features\n\n- **Automated API Generation**: Instant creation of CRUD, Search, and Aggregate endpoints from JSON configurations.\n- **Database Schema Management**: Automatic handling of table creation, multi-column indexes, and foreign key constraints.\n- **Multi-Engine Database Support**: Native support for both PostgreSQL and SQLite.\n- **Interactive Documentation**: Integrated Swagger/OpenAPI UI available at the specified documented path.\n- **Robust Validation**: Driven by AJV (JSON Schema) for strict and customizable request validation.\n- **Advanced Querying**: Native support for filtering, sorting, and complex search operations.\n\n## Quick Start\n\n### 1. Installation\n\nClone the repository and install dependencies:\n\n```bash\ngit clone https://github.com/imdeepmind/rocket.git\ncd rocket\nnpm install\n```\n\n### 2. Initialize the Server\n\nStart the server using an existing configuration file:\n\n```bash\nnpm run dev -- -c example_config.json\n```\n\n### 3. API Exploration\n\nOnce the server is initialized, refer to the Swagger UI for interactive API documentation:\n[http://localhost:3000/api/docs](http://localhost:3000/api/docs)\n\n## Configuration\n\nRocket utilizes a `config.json` file for system orchestration. Below is an overview of the primary configuration blocks:\n\n```json\n{\n  \"swagger\": {\n    \"enabled\": true,\n    \"basePath\": \"/api/docs\",\n    \"info\": { \"title\": \"Rocket API\", \"version\": \"1.0.0\" }\n  },\n  \"database\": {\n    \"engine\": \"sqlite\",\n    \"connection\": { \"urlOrPath\": \"./database.db\" }\n  },\n  \"models\": [\n    {\n      \"name\": \"users\",\n      \"fields\": [\n        { \"name\": \"id\", \"type\": \"integer\", \"primaryKey\": true },\n        { \"name\": \"email\", \"type\": \"string\", \"unique\": true, \"supportedOperations\": [\"searchable\", \"equal\", \"sortable\"] }\n      ]\n    }\n  ]\n}\n```\n\n### Field Operations\n\nSpecific operations can be enabled per field to control API exposure:\n\n- `searchable`: Enables full-text search capabilities on the specific field.\n- `equal`, `greaterThan`, `oneOf`: Provides granular filtering options.\n- `sortable`: Permits sorting based on the field values.\n\n## API Reference\n\nRocket generates standardized endpoints for every configured model.\n\n| Method | Endpoint | Description |\n| :--- | :--- | :--- |\n| `POST` | `/:model` | Creates a new record. |\n| `GET` | `/:model` | Retrieves records with pagination and filtering support. |\n| `PATCH` | `/:model/:id` | Performs partial updates on a specific record. |\n| `DELETE` | `/:model/:id` | Deletes a specific record. |\n| `POST` | `/:model/search` | Executes advanced search queries. |\n| `POST` | `/:model/aggregate` | Performs data aggregations (e.g., count). |\n\n## Development and Testing\n\n### Testing\n\nTesting is managed via Vitest to ensure performance and reliability.\n\n```bash\n# Execute the test suite\nnpm test\n\n# Generate coverage data\nnpm run coverage\n```\n\n### Code Quality\n\nLinting is enforced to maintain high code standards:\n\n```bash\nnpm run lint:check\n```\n\n## Technology Stack\n\n- **Runtime**: Node.js\n- **Framework**: Fastify\n- **Architecture**: TypeScript\n- **Database**: PostgreSQL and SQLite\n- **Validation**: AJV\n- **Documentation**: Swagger / OpenAPI\n- **Testing**: Vitest\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimdeepmind%2Frocket","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimdeepmind%2Frocket","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimdeepmind%2Frocket/lists"}