Getting Started

Configuration

Learn how to configure your CanxJS application using the configuration file and environment variables.

App Configuration

The main application configuration lives in src/config/app.ts.

src/config/app.ts

1// src/config/app.ts
2export default {
3  name: "CanxJS App",
4  env: process.env.NODE_ENV || "development",
5  port: Number(process.env.PORT) || 3000,
6  key: process.env.APP_KEY || "your-secret-key",
7  debug: process.env.DEBUG === "true",
8  
9  // You can add custom config here
10  security: {
11    cors: true,
12    rateLimit: true,
13  }
14};

Database Configuration

Configure your database connection in src/config/database.ts.

src/config/database.ts

1// src/config/database.ts
2import type { DatabaseConfig } from 'canxjs';
3
4const config: DatabaseConfig = {
5  driver: process.env.DB_CONNECTION as any || "mysql",
6  host: process.env.DB_HOST || "localhost",
7  port: Number(process.env.DB_PORT) || 3306,
8  database: process.env.DB_NAME || "canx_app",
9  username: process.env.DB_USER || "root",
10  password: process.env.DB_PASS || "",
11  logging: process.env.NODE_ENV !== "production",
12  pool: { min: 2, max: 10 },
13};
14
15export default config;

Environment Variables

Use environment variables to store sensitive configuration. Create a .env file in your project root.

.env

1# .env
2NODE_ENV=development
3PORT=3000
4
5# Database
6DB_HOST=localhost
7DB_PORT=3306
8DB_NAME=canx_app
9DB_USER=root
10DB_PASS=secret
11
12# Security
13JWT_SECRET=your-secret-key
14SESSION_SECRET=your-session-secret
15
16# Cache
17REDIS_URL=redis://localhost:6379

Directory Structure

You can customize the directory structure of your application by creating a canx.config.ts configuration file. This allows you to adopt different architectural patterns like NestJS or Express style structures.

canx.config.ts

1// canx.config.ts
2export default {
3  paths: {
4    controllers: 'src/http/controllers',
5    models: 'src/domain/models',
6    middlewares: 'src/http/middleware',
7    migrations: 'database/migrations',
8    services: 'src/domain/services',
9  }
10};

Configuration Options

App Configuration

Core application settings

Option	Type	Default	Description
port	number	3000	Server port
host	string	localhost	Server hostname
env	string	development	Environment mode
debug	boolean	false	Enable debug mode

Database Configuration

Database connection settings

Option	Type	Default	Description
driver	string	mysql	Database driver (mysql, postgres)
host	string	localhost	Database host
port	number	3306	Database port
database	string	-	Database name
username	string	-	Database username
password	string	-	Database password

Security Configuration

Security and authentication settings

Option	Type	Default	Description
cors.enabled	boolean	true	Enable CORS
cors.origin	string \| array	*	Allowed origins
rateLimit.enabled	boolean	true	Enable rate limiting
rateLimit.max	number	100	Max requests per window
rateLimit.window	number	60000	Window in ms

Next Steps

Now that you understand configuration, learn about routing and controllers.

Getting Started

Configuration

Learn how to configure your CanxJS application using the configuration file and environment variables.

App Configuration

The main application configuration lives in src/config/app.ts.

src/config/app.ts

1// src/config/app.ts
2export default {
3  name: "CanxJS App",
4  env: process.env.NODE_ENV || "development",
5  port: Number(process.env.PORT) || 3000,
6  key: process.env.APP_KEY || "your-secret-key",
7  debug: process.env.DEBUG === "true",
8  
9  // You can add custom config here
10  security: {
11    cors: true,
12    rateLimit: true,
13  }
14};

Database Configuration

Configure your database connection in src/config/database.ts.

src/config/database.ts

1// src/config/database.ts
2import type { DatabaseConfig } from 'canxjs';
3
4const config: DatabaseConfig = {
5  driver: process.env.DB_CONNECTION as any || "mysql",
6  host: process.env.DB_HOST || "localhost",
7  port: Number(process.env.DB_PORT) || 3306,
8  database: process.env.DB_NAME || "canx_app",
9  username: process.env.DB_USER || "root",
10  password: process.env.DB_PASS || "",
11  logging: process.env.NODE_ENV !== "production",
12  pool: { min: 2, max: 10 },
13};
14
15export default config;

Environment Variables

Use environment variables to store sensitive configuration. Create a .env file in your project root.

.env

1# .env
2NODE_ENV=development
3PORT=3000
4
5# Database
6DB_HOST=localhost
7DB_PORT=3306
8DB_NAME=canx_app
9DB_USER=root
10DB_PASS=secret
11
12# Security
13JWT_SECRET=your-secret-key
14SESSION_SECRET=your-session-secret
15
16# Cache
17REDIS_URL=redis://localhost:6379

Directory Structure

canx.config.ts

1// canx.config.ts
2export default {
3  paths: {
4    controllers: 'src/http/controllers',
5    models: 'src/domain/models',
6    middlewares: 'src/http/middleware',
7    migrations: 'database/migrations',
8    services: 'src/domain/services',
9  }
10};

Configuration Options

App Configuration

Core application settings

Option	Type	Default	Description
port	number	3000	Server port
host	string	localhost	Server hostname
env	string	development	Environment mode
debug	boolean	false	Enable debug mode

Database Configuration

Database connection settings

Option	Type	Default	Description
driver	string	mysql	Database driver (mysql, postgres)
host	string	localhost	Database host
port	number	3306	Database port
database	string	-	Database name
username	string	-	Database username
password	string	-	Database password

Security Configuration

Security and authentication settings

Option	Type	Default	Description
cors.enabled	boolean	true	Enable CORS
cors.origin	string \| array	*	Allowed origins
rateLimit.enabled	boolean	true	Enable rate limiting
rateLimit.max	number	100	Max requests per window
rateLimit.window	number	60000	Window in ms

Next Steps

Now that you understand configuration, learn about routing and controllers.