First Steps

Language

GamanJS is specifically designed to work with TypeScript and modern JavaScript using the ECMAScript (ESM) module system. This means all modules must be written using import and export syntax; CommonJS (require, module.exports) is not supported. If you are building a project with GamanJS, ensure your environment and codebase are fully compatible with ESM.

Prerequisites

Please ensure Node.js (version >= 20.x) is installed on your operating system.

---

Create your first project

GamanJS is a framework for backend applications, you can create it using your favorite package manager:

npm

npm create gaman@latest

pnpm

pnpm create gaman@latest

yarn

yarn create gaman

bun

bun create gaman@latest

Project Structure

After creating a new project, your file structure will look like this:

• Directory

  src

  • Directory

    controllers

    • AppController.ts
  • Directory

    routes

    • AppRoutes.ts

  • index.d.ts

  • index.ts

• package.json

• tsconfig.json