README.md

OWL (v1) Javascript Project Starter

Warning This project uses OWL version 1, OWL v2 is out (used in Odoo 16) and is the preferred version of the framework! Use this starter project only if you are following the Tutorial on https://codingdodo.com, if not please prefer this repository OWL2-JavaScript-Project-Starter

This repo is an example on how to start a real project with the Odoo OWL framework.

Thanks to @SimonGenin for it's original Starter Project for OWL

Features

• OWL v1.4.5
• Javascript
• Livereload
• Rollup.js v2.57
• Tests with Jest v27

Installation

This repo is a "template repository". It means you can quickly create repositories based on this one, without it being a fork.

Otherwise, you may clone it:

git clone https://github.com/Coding-Dodo/OWL-JavaScript-Project-Starter.git

Install dependencies:

npm install

Dev with livereload:

npm run dev

Production build

npm run build

Run tests

npm run test

Components

It is expected to create components in one file, following this convention:

import { Component, useState, tags } from "@odoo/owl";

const APP_TEMPLATE = tags.xml/*xml*/ `
<div t-name="App" class="" t-on-click="update">
  Hello <t t-esc="state.text"/>
</div>
`;

export class App extends Component {
  static template = APP_TEMPLATE;
  state = useState({ text: "Owl" });
  update() {
    this.state.text = this.state.text === "Owl" ? "World" : "Owl";
  }
}

See also

If your are searching for the a project starter with Tailwind and PostCSS:

https://github.com/Coding-Dodo/OWL-JavaScript-Tailwind-Project-Starter