api-forgex-cli

A CLI tool for scaffolding scalable and modular Express.js backend infrastructure. api-forgex-cli helps you quickly bootstrap a Node.js server with interactive prompts, offering out-of-the-box support for Databases, JWT authentication, and automatic API documentation.

Features

• Interactive Setup: Configure your project easily through intuitive CLI prompts.
• Modular Architecture: Choose only the addons you need (Database, JWT, Users Domain).
• Docker Ready: Automatically generates docker-compose.yml for database containers if selected.
• API Documentation: Seamless integration with nodejs-api-docgen for instant documentation.
• Zero Configuration: Automatically installs all required dependencies based on your choices.

Quick Start

You don't need to install this package globally. Just use npx to generate your new project directly.

# Generate a new project in current directory
npx api-forgex-cli

Available Scripts

Once your project is generated, navigate to your project folder and run the following commands:

cd my-project

# Start the database container (Requires Docker to be running)
docker compose up -d

# Start the application
npm start

# Start in watch mode
npm run dev

Note: If you selected API documentation, npm start will automatically generate documentation.

Default Test Accounts (Users Domain)

If you selected the Users Domain and Database addons during setup, the initial database is automatically seeded with five test accounts. You can use these accounts to easily test JWT authentication and user status logic.

The password for all test accounts is: password

Username (ID)	Email	Status	Description
nnxi	nnxi@test.com	ACTIVE	Normal active user
test1	test1@test.com	ACTIVE	Normal active user
test2	test2@test.com	SUSPENDED	Suspended user
test3	test3@test.com	ACTIVE	Withdrawn user (Soft-deleted)
test4	test4@test.com	SUSPENDED	Suspended and withdrawn user

Frontend Demo Client

Are you a beginner wanting to see the simple connection cycle between the frontend and backend? We provide a lightweight demo client!

You can clone the frontend repository from the link below and easily test the JWT authentication and User APIs using the default test accounts.

• Test it here: nnxi/api-forgex-demo

License

MIT