accounting/books
2
0
Fork 0
mirror of https://github.com/frappe/books.git synced 2024-09-20 19:29:02 +00:00
Code Issues Releases Activity
a12fc981bb
books/docs/app.md

110 lines
2.3 KiB
Markdown
Raw Normal View History

:boom: frappejs
2018-01-16 06:09:17 +00:00
# Creating a new App
version 0.1
2018-01-16 06:35:07 +00:00
app.md
2018-01-16 07:29:49 +00:00
## Install Frappe.js
app.md
2018-01-16 06:49:38 +00:00
version 0.1
2018-01-16 06:35:07 +00:00
```
yarn add frappejs
```
app.md
2018-01-16 06:49:38 +00:00
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
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.
app.md
2018-01-16 06:49:38 +00:00
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
## Config
app.md
2018-01-16 06:49:38 +00:00
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
FrappeJS requires a file named `frappe.conf.js` to be present in the root of your directory. Minimum configuration looks like:
app.md
2018-01-16 06:49:38 +00:00
```
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
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
}
}
app.md
2018-01-16 06:49:38 +00:00
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
```
app.md
2018-01-16 06:49:38 +00:00
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
You also need an `index.html` located in the `src` directory. It can look like
app.md
2018-01-16 06:49:38 +00:00
```html
<!DOCTYPE html>
<html lang="en">
<head>
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>My Awesome App</title>
app.md
2018-01-16 06:49:38 +00:00
</head>
<body>
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
<div id="app"></div>
app.md
2018-01-16 06:49:38 +00:00
</body>
</html>
```
yarn link in docs
2018-03-21 09:48:01 +00:00
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
### Server
app.md
2018-01-16 06:49:38 +00:00
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
Assuming you have a `server/index.js` file, you can start the frappejs server in just a few lines of code.
app.md
2018-01-16 06:49:38 +00:00
```js
const server = require('frappejs/server');
server.start({
backend: 'sqlite',
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
connection_params: {
db_path: 'test.db'
}
app.md
2018-01-16 06:49:38 +00:00
});
```
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
### Client
app.md
2018-01-16 06:49:38 +00:00
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
In your client file you will have to initialize `frappe` and `models`.
app.md
2018-01-16 06:49:38 +00:00
`frappejs/client` lib will initialize your server and user interface with the Desk.
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
Example starting point for an app:
app.md
2018-01-16 06:49:38 +00:00
```js
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
import frappe from 'frappejs';
import io from 'socket.io-client';
import HTTPClient from 'frappejs/backends/http';
import common from 'frappejs/common';
import coreModels from 'frappejs/models';
app.md
2018-01-16 07:29:49 +00:00
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
frappe.init();
frappe.registerLibs(common);
frappe.registerModels(coreModels);
app.md
2018-01-16 07:29:49 +00:00
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
const server = 'localhost:8000';
frappe.fetch = window.fetch.bind();
frappe.db = new HTTPClient({ server });
const socket = io.connect(`http://${server}`);
frappe.db.bindSocketClient(socket);
app.md
2018-01-16 07:29:49 +00:00
```
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
## Start
app.md
2018-01-16 07:29:49 +00:00
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
To start the server and build webpack simultaneously you can use the cli command
app.md
2018-01-16 07:29:49 +00:00
Update documentation for new app (#86)
2018-09-11 18:15:18 +00:00
```bash
./node_modules/.bin/frappe start
Updated docs Spelling correction
2018-02-13 10:05:41 +00:00
```
Copy Permalink