Installation

Create a new OpenSya project in seconds using the official CLI.

OpenSya helps you build modular, scalable and fully owned recruitment platforms powered by a convention-driven fullstack runtime.

Create a Project

pnpm create opensya my-app

yarn create opensya my-app

npm create opensya my-app

bun create opensya my-app

The CLI downloads the starter template, configures the project and installs dependencies automatically.

During setup, OpenSya may ask a few questions:

◆ Welcome to Opensya!

? Where would you like to create your project? ./my-app
? Which package manager would you like to use? pnpm
? Initialize git repository? yes

→ Creating project in my-app
✓ Dependencies installed
✓ Git repository initialized

✨ Opensya project has been created with the default template.

Start the Development Server

Move into the project directory:

cd my-app

Then start the development server:

pnpm run dev

yarn dev

npm run dev

bun run dev

OpenSya automatically generates and orchestrates the backend runtime while Nuxt handles the frontend runtime.

Project Structure

A freshly created OpenSya project looks like this:

my-app/
├── server/
│   ├── controllers/
│   ├── services/
│   ├── database/
│   │   ├── models/
│   │   └── plugins/
│   ├── guards/
│   └── locales/
│
├── client/
│   ├── pages/
│   ├── components/
│   └── plugins/
│
├── .env
└── opensya.config.ts

The server/ directory powers the backend runtime generated with NestJS.

The client/ directory powers the frontend runtime delegated to Nuxt.

Templates

OpenSya currently provides two starter templates.

Create a module project:

pnpm create opensya my-module --template module

yarn create opensya my-module --template module

npm create opensya my-module -- --template module

bun create opensya my-module --template module

Next Steps

Now that your project is running, continue with the core concepts and architecture documentation.