Catberry.js

How to use Catberry.js

Catberry.js is a framework that allows you to build universal JavaScript applications using the concept of isomorphic rendering. Here are the steps to use Catberry.js:

1. Installation: Install Catberry.js by running the following command in your project directory:

   npm install catberry --save
   

2. Configuration: Create a

   catberry.json
   file in your project's root directory to configure Catberry.js. You can specify settings such as routes, server port, and other options. Here's an example of a basic configuration:

   {
     "development": {
       "isRelease": false,
       "server": {
         "port": 3000,
         "ip": "localhost"
       },
       "logging": {
         "level": "info"
       }
     },
     "production": {
       "isRelease": true,
       "server": {
         "port": 80,
         "ip": ""
       },
       "logging": {
         "level": "warning"
       }
     },
     "logger": {
       "fileAppender": {
         "type": "rotating-file",
         "options": {
           "path": "./logs/",
           "maximumFiles": 10,
           "fileNamePattern": "app-%DATE%.log"
         }
       }
     }
   }
   

3. Creating Routes: Define routes for your application in the

   routes.js
   file. This file specifies which components should be rendered for each URL. Here's an example:

   module.exports = [
     {
       expression: '/',
       component: 'home-page'
     },
     {
       expression: '/about',
       component: 'about-page'
     }
   ];
   

4. Defining Components: Create reusable components using Catberry.js syntax. A component consists of a template and a controller. The template defines the structure of the component, while the controller contains the logic. Here's an example:

   <!-- home-page.html -->
   <h1>Welcome to the Home Page!</h1>
   
   <ul>
     <li cat-component="todo-list-item" cat-store="todos.items[0]"></li>
     <li cat-component="todo-list-item" cat-store="todos.items[1]"></li>
   </ul>
   

   // home-page.js
   module.exports = function HomePage() {
     this.todos = [
       { id: 1, text: 'Task 1' },
       { id: 2, text: 'Task 2' }
     ];
   };
   

5. Building and Running: Build your Catberry.js application by running the following command:

   catberry build -c catberry.json
   

   This will generate a

   build
   directory containing the compiled version of your application. To start the server, run:

   catberry run -c catberry.json
   

6. Accessing your Application: You can now access your Catberry.js application in a web browser by navigating to

   http://localhost:3000
   (or the port you specified in the configuration).

By following these steps, you can use Catberry.js to build isomorphic JavaScript applications with reusable components and universal rendering.