accounting/books
2
0
Fork 0
mirror of https://github.com/frappe/books.git synced 2025-01-23 23:28:24 +00:00
Code Issues Releases Activity

Update documentation for new app (#86)

Browse Source
This commit is contained in:
Faris Ansari 2018-09-11 23:45:18 +05:30 committed by GitHub
parent 0a354fa5c1
commit dc7f7be447
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 59 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

139
docs/app.md
View File

@ -6,125 +6,104 @@
yarn add frappejs yarn add frappejs
``` ```
FrappeJS comes with built in rollup config for your files FrappeJS comes with an Express Server on the backend, VueJS for the front-end and a CLI to run these things with built-in webpack configs.
## Build ## Config
There are 2 files that get built for the Desk single page application FrappeJS requires a file named `frappe.conf.js` to be present in the root of your directory. Minimum configuration looks like:
- `/dist/js/bundle.js` ```
- `/dist/css/style.css` module.exports = {
staticPath: './static', // uploaded files are served from this directory
distPath: './dist', // bundled assets are built and served here
dev: {
// your client side entry files
entry: {
app: './src/main.js'
},
outputDir: './dist',
assetsPublicPath: '/',
devServerPort: 8000,
env: {
PORT: process.env.PORT || 8000
}
},
node: {
paths: {
main: 'server/index.js' // your server entry file
}
},
electron: {
// wip
}
}
Your `rollup.config.js` should look like:
```js
module.exports = [
require('frappejs/config/rollup.config.style.js'),
require('frappejs/config/rollup.config.app.js')
]
``` ```
## Create a basic app You also need an `index.html` located in the `src` directory. It can look like
### index.html
The UI for the single page app (desk) will be built inside the `body` element, so you just need to have an empty body element, and link your JS bundle in `index.html`
Sample index.html
```html ```html
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title> <meta http-equiv="X-UA-Compatible" content="ie=edge">
<link href="/dist/css/style.css" rel="stylesheet"> <title>My Awesome App</title>
</head> </head>
<body> <body>
<script src="/dist/js/socket.io.js"></script> <div id="app"></div>
<script src="js/bundle.js"></script>
</body> </body>
</html> </html>
``` ```
## For development setup
Clone frappejs in the same folder as your app, since you will be developing frappejs on the side. ### Server
### Link frappejs Assuming you have a `server/index.js` file, you can start the frappejs server in just a few lines of code.
```sh
# make frappejs linkable
cd frappejs
yarn link
yarn link frappejs
# link frappejs in all
cd ../myapp
yarn link frappejs
# install libs
yarn
```
### server.js
Create your server file `server.js`
```js ```js
const server = require('frappejs/server'); const server = require('frappejs/server');
server.start({ server.start({
backend: 'sqlite', backend: 'sqlite',
connection_params: {db_path: 'test.db'}, connection_params: {
static: './' db_path: 'test.db'
}
}); });
``` ```
### index.js ### Client
In your client file you will have to import all your controllers and init them. In your client file you will have to initialize `frappe` and `models`.
`frappejs/client` lib will initialize your server and user interface with the Desk. `frappejs/client` lib will initialize your server and user interface with the Desk.
Example starting point for a to-do app: Example starting point for an app:
```js ```js
const client = require('frappejs/client');
const todo = require('frappejs/models/doctype/todo/todo.js');
// start server import frappe from 'frappejs';
client.start({ import io from 'socket.io-client';
server: 'localhost:8000', import HTTPClient from 'frappejs/backends/http';
}).then(() => { import common from 'frappejs/common';
frappe.init_controller('todo', todo); import coreModels from 'frappejs/models';
frappe.desk.add_sidebar_item('Home', '#'); frappe.init();
frappe.desk.add_sidebar_item('New ToDo', '#new/todo'); frappe.registerLibs(common);
frappe.registerModels(coreModels);
const server = 'localhost:8000';
frappe.fetch = window.fetch.bind();
frappe.db = new HTTPClient({ server });
const socket = io.connect(`http://${server}`);
frappe.db.bindSocketClient(socket);
frappe.router.default = '/list/todo';
frappe.router.show(window.location.hash);
});
``` ```
## Start ## Start
To start the app and build webpack simultaneously you can use a `Procfile` To start the server and build webpack simultaneously you can use the cli command
```yml ```bash
server: nodemon server.js ./node_modules/.bin/frappe start
watch: node_modules/.bin/rollup -c --watch
```
You can use any procfile handler like `node-foreman` to start the processes.
```
yarn global add foreman
```
Then
```
nf start
``` ```