Quick Start Guide

Welcome to Nijor! This guide will help you set up, run, and build your very first Nijor web application in just a few minutes.

1. Scaffold a New Project

You can quickly create a pre-configured project structure using our CLI tool. Choose your preferred package manager to run the initializer:


            npx create-nijor-app my-app
        

If you prefer using Bun for faster performance, you can use:


            bunx create-nijor-app my-app
        

2. Start the Development Server

Navigate to your new project directory and spin up the local development server. Nijor uses Bun to deliver an exceptionally fast development cycle:


            cd my-app
            bun run dev
        

Once started, the development server will be active at http://localhost:3000 with live reload fully enabled. Any changes you make to your components or routes will instantly reflect in the browser. You can customize the server port and reload settings inside the nijor.config.js file.

3. Build for Production

When your application is ready to be deployed, generate an optimized production build using the following command:


            bun run build
        

This command triggers the Nijor compiler to analyze your routes, bundle your static assets, compile your scoped styling, and output a highly optimized, production-ready version of your app.

Next Steps

Now that your local environment is running, dive into Components to see how to build user interfaces, or explore Routing to understand file-based page organization in Nijor!