NextERP/owl
2
0
Fork 0
mirror of https://github.com/odoo/owl.git synced 2025-10-06 19:59:41 +07:00
Code Issues Packages Projects Releases Wiki Activity

update documentation

Browse Source
This commit is contained in:
Géry Debongnie
2019-03-17 08:57:18 +01:00
parent 46aedf78af
commit 9e608dae49
3 changed files with 29 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+18 -17
View File
@@ -31,14 +31,6 @@ ideas:
Note: the code is written in typescript. This does not mean that the main web
client will ever be converted to typescript (even though I would really like it).
## Web client demo
To test and play with the component class, there is a demo application located
in the _demo/_ folder. It is a rethink of what the web client could look like
if it is ever rebuilt from scratch. It is currently an experiment. But
obviously, we hope someday to be able to use this work and actually rewrite
completely the odoo web client.
## Main scripts
To install every dependency needed to play with this code:
@@ -60,18 +52,27 @@ npm run test
npm run test:watch
```
To play with the demo application:
```
npm run demo:build # make a build in dist/app/
npm run demo:dev # make a build in dist/app/, and make a live server to access it
```
The _demo:dev_ task will build the app (without minification), then start a live-server with hot-reloading, and watch the file system to make sure
that assets are properly rebuilt if necessary, and then reloaded.
Note that the test scripts also run the example tests suites.
## Documentation
- [Quick Start](doc/quick_start.md)
- [Component](doc/component.md)
- [QWeb](doc/qweb.md)
## Examples
There are two examples of how to work with this web framework:
- [Demo Application](examples/demo/readme.md)
- [Web Client](examples/web/readme.md)
To play with the examples:
```
npm run example:build # make a build in dist/app/
npm run example:dev # make a build in dist/app/, and make a live server to access it
```
The _example_:dev\_ task will build the app (without minification), then start a live-server with hot-reloading, and watch the file system to make sure
that assets are properly rebuilt if necessary, and then reloaded.
examples/demo/readme.md
+4
View File
@@ -0,0 +1,4 @@
# Demo
This example is just a playground to experiment/showcase some features of
the framework.
examples/web/readme.md
+7
View File
@@ -0,0 +1,7 @@
# Web Client Example
To test and play with the component class, there is a demo application located
in the _examples/web/_ folder. It is a rethink of what the web client could look like
if it is ever rebuilt from scratch. It is currently an experiment. But
obviously, we hope someday to be able to use this work and actually rewrite
completely the odoo web client.