Skip to content
imdeepmindPublic

About

Rocket is a configuration-driven API framework designed to create APIs, manage databases.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Rocket Repository

This repository contains two independent software projects maintained by Abhishek Chatterjee:


Projects Overview

1. ROSS (ross/)

ROSS is an open-source, configuration-driven REST API framework. By defining data models in a structured JSON schema, ROSS automatically handles:

  • Automated API Generation: CRUD, Search, Index, and Aggregate endpoints generated instantly from JSON configuration.
  • Database Schema Management: Automatic table generation, relationships, multi-column indexes, and foreign keys for PostgreSQL and SQLite.
  • Built-in Authentication: JWT-based authentication with registration, login, password reset, and optional MFA.
  • Caching & Rate Limiting: Redis integration and configurable request throttling.
  • Interactive Documentation: Integrated Swagger/OpenAPI documentation UI at /docs.
  • Full Source Code: Located in ross/.
  • License: MIT License.

Barebone Configuration Example

The smallest configuration required to boot a working API is just an application name and a single model:

{
  "application": { "name": "Barebone API" },
  "data": {
    "models": {
      "notes": {
        "fields": {
          "id": { "type": "integer", "primaryKey": true, "autoIncrement": true },
          "title": { "type": "string", "nullable": false },
          "body": { "type": "text", "nullable": true }
        }
      }
    }
  }
}

Running ROSS

Start the server using the barebone configuration:

# Run directly from repository root:
./dev.sh dev

# Or from within ross/:
cd ross
npm run dev -- -c examples/01-barebone/barebone_config.json

This single model automatically provides a complete RESTful API backed by SQLite:

  • POST /notes — Create a note
  • GET /notes — List notes with pagination and sorting
  • GET /notes/id/:id — Fetch note by ID
  • GET /notes/search/title?title_search=... — Search notes
  • Interactive Swagger UI — Explore endpoints at http://localhost:3000/docs

For complete installation, configuration options, and advanced feature guides, see the full ROSS Documentation.

2. Rocket (rocket/)

Rocket is a source-available backend deployment, hosting, and management platform designed to run and orchestrate backend applications and APIs (such as those generated by ROSS).

  • Core Capabilities: Application hosting, deployment pipelines, infrastructure provisioning, and operational management.
  • Full Source Code: Located in rocket/.
  • License: PolyForm Shield License 1.0.0.

For more details, see the Rocket Platform Documentation.


Repository Structure

.
├── LICENSE          # Repository licensing overview
├── README.md        # This file (repository overview)
├── CONTRIBUTING.md  # Unified contribution guidelines
├── ross/            # ROSS open-source API builder framework (MIT)
│   ├── LICENSE      # MIT License
│   ├── README.md    # ROSS framework documentation
│   ├── src/         # Framework source code
│   ├── tests/       # Unit and integration test suite
│   ├── e2e/         # End-to-end test suite
│   └── docs/        # Documentation site
└── rocket/          # Rocket platform (PolyForm Shield 1.0.0)
    ├── LICENSE      # PolyForm Shield License 1.0.0
    └── README.md    # Rocket platform documentation

Licensing

This repository uses a dual-project licensing structure:

  1. ROSS (/ross) is licensed under the MIT License. See ross/LICENSE.
  2. Rocket (/rocket) is licensed under the PolyForm Shield License 1.0.0. See rocket/LICENSE.

The root LICENSE file serves as an informational overview of the repository's licensing terms. Each license applies only to its respective project directory.


Contributing

We welcome contributions to both projects! Please review CONTRIBUTING.md for contribution guidelines, licensing terms, and pull request procedures.

About

Rocket is a configuration-driven API framework designed to create APIs, manage databases.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages