Knexpresso

A batteries-included Node.js framework for building production-ready APIs with TypeScript.

Overview

Welcome to Knexpresso, a comprehensive toolkit designed to streamline and accelerate backend development. By seamlessly integrating essential libraries like Knex.js and Express.js, Knexpresso provides a complete, out-of-the-box solution for database management, API creation, authentication, and cloud deployment. Its powerful Command-Line Interface (CLI) automates project setup and simplifies ongoing management, empowering you to bypass boilerplate and focus entirely on your application's core business logic.

Core Features

• Rapid API Development: Express-based, with helpers for routing and middleware.
• Database Management: Robust Knex.js integration for query building, migrations, and seeding.
• Authentication: Built-in support for common authentication patterns.
• AWS Integration: Utilities for services like S3, SQS, ECS, and Secrets Manager.
• Deployment: Tools to build and deploy your application, with specific support for AWS ECS.
• CLI Tooling: A comprehensive command-line interface to manage the entire project lifecycle.

Getting Started

Installation

To start a new project with Knexpresso, run the init command:

npx knexpresso init --project-name my-awesome-project

This will scaffold a new project in a directory with the specified name.

Development

To start the development server with hot-reloading:

npm run dev

This uses nodemon to watch for file changes in your project and automatically restart the server.

CLI Commands

Knexpresso provides a rich set of commands to streamline development:

• knexpresso init: Initialize a new project.
• knexpresso dev: Start the development server with hot-reloading.
• knexpresso build: Build the project for production.
• knexpresso start: Run the production build.
• knexpresso migrate:make <name>: Create a new database migration file.
• knexpresso migrate:latest: Run all pending database migrations.
• knexpresso seed:run: Run seed files to populate your database.
• knexpresso api:document: Generate API documentation from your code.
• knexpresso secret:make: Generate local secret keys for development.

For more information on a specific command, you can use the help flag:

knexpresso <command> --help