PACKAGES

Rasengan Serve

@rasenganjs/serve is a simple utility to launch your Rasengan.js application in production mode. It serves the built application from the dist directory, ensuring a smooth and optimized deployment.

Installation

To use @rasenganjs/serve, install it as a dependency in your project:

Terminal
npm install @rasenganjs/serve

Usage

After building your application with Rasengan.js, you can start the production server using the rasengan-serve command.

Start the production server

[01]Define the serve command
Add the following command to your `package.json` file to start the production server:
package.json
{
  "scripts": {
    "serve": "rasengan-serve ./dist"
  }
}
[02]Run the serve command
Run the following command in your terminal:

bash title="Terminal" npm run serve

This will start a server that serves your application from the dist folder.

Options

Currently, @rasenganjs/serve provides a default configuration for serving your built project. Future updates may include additional options for customization.

Custom port

You can specify a custom port for the server by using the -p or --port option:

Terminal
npm run serve -- -p 3000

or

Terminal
pnpm run serve -p 3000

The -p/--port option lets you replace the default port 4320 for the production server. You can also set a PORT environment variable instead; -p/--port takes priority over it if both are set. If the resolved port is already in use, @rasenganjs/serve automatically falls back to the next free one.

Bun Support

Introduced in v2.0.0-beta, @rasenganjs/serve can also run your app on Bun instead of Node.js. Set runtime: 'bun' in your rasengan.config.js:

rasengan.config.js
import { defineConfig } from 'rasengan';
 
export default defineConfig({
  runtime: 'bun',
});

Then build and serve as usual, the exact same rasengan-serve ./dist command works for both runtimes:

Terminal
npm run build
npm run serve

Community

Join the Rasengan.js community to get support, ask questions, and share your projects:

Let's build something amazing with Rasengan.js! 🚀

License

This package is MIT licensed.