Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/NagariaHussain/doppio
A Frappe app (CLI) to magically setup single page applications and Vue/React powered desk pages on your custom Frappe apps.
https://github.com/NagariaHussain/doppio
frappe frappe-framework python react reactjs spa tailwindcss vitejs vue vuejs
Last synced: 4 months ago
JSON representation
A Frappe app (CLI) to magically setup single page applications and Vue/React powered desk pages on your custom Frappe apps.
- Host: GitHub
- URL: https://github.com/NagariaHussain/doppio
- Owner: NagariaHussain
- License: mit
- Created: 2021-07-18T08:17:35.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-12T08:45:26.000Z (7 months ago)
- Last Synced: 2024-05-15T20:07:28.567Z (7 months ago)
- Topics: frappe, frappe-framework, python, react, reactjs, spa, tailwindcss, vitejs, vue, vuejs
- Language: Python
- Homepage:
- Size: 214 KB
- Stars: 148
- Watchers: 7
- Forks: 64
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: license.txt
Awesome Lists containing this project
- awesome-frappe - Doppio - Magically setup single page applications on your Frappe Apps. (Uncategorized / Uncategorized)
README
# Doppio
A Frappe App to setup and manage single page applications and custom desk pages (using Vue 3 or React) on your custom Frappe App.
## Installation
In your bench directory:
```bash
bench get-app https://github.com/NagariaHussain/doppio
```
This will install the `Doppio` frappe app on your bench and enable some custom bench CLI commands
that will ease the process of attaching a SPA to your Frappe Application.
## Setting Up React/Vue SPA
To set up a new Single Page Application, you can run the following command in your bench directory:
```bash
bench add-spa --app [--tailwindcss] [--typescript]
# or just, and answer the prompts
bench add-spa
```
You will be prompted to enter a name for your single page application, this will be the name of the directory and the URI path at which the application will be served. For instance, if you enter `dashboard` (default), then a folder named `dashboard` will be created inside your app's root directory and the application will be served at `/dashboard`.
You will then be asked to select the framework you prefer: React or Vue.
You can also select whether you want to use Typescript or Javascript.
You can optionally pass the `--tailwindcss` flag which will also setup tailwindCSS (who doesn't like tailwind!) along with the Vue 3/React application.
The above command will do the following things:
### For Vue 3
1. Scaffold a new Vue 3 starter application (using [Vite](https://vitejs.dev/))
2. Add and configure Vue router
3. Link utility and controller files to make the connection with Frappe backend a breeze!
4. Configure Vite's proxy options (which will be helpful in development), check the `proxyOptions.js` file to see to what ports the Vite dev server proxies the requests (you frappe bench server).
5. Optionally, installs and set up tailwindCSS.
6. Update the `website_route_rules` hook (in `hooks.py` of your app) to handle the routing of this SPA.
### For React
1. Scaffold a new React starter application (using [Vite](https://vitejs.dev/))
2. Add and configure [frappe-react-sdk](https://github.com/nikkothari22/frappe-react-sdk) to make the connection with Frappe backend a breeze!
3. Configure Vite's proxy options (which will be helpful in development), check the `proxyOptions.js` file to see to what ports the Vite dev server proxies the requests (you frappe bench server).
4. Optionally, installs and set up tailwindCSS.
5. Update the `website_route_rules` hook (in `hooks.py` of your app) to handle the routing of this SPA.
Once the setup is complete, you can `cd` into the SPA directory of your app (e.g. `dashboard`) and run:
```bash
yarn dev
```
This will start a development server at port `8080` by default (any other port if this port's already in use). You can view the running application at: `:8080`.
## Adding FrappeUI
If you want to add a [frappe-ui](https://github.com/frappe/frappe-ui) starter project to your custom app, you can do that using just a single command:
```bash
bench add-frappe-ui
```
## Creating Desk Pages
If you want to setup Vue 3 or React powered custom desk pages, you can do that with just a single command:
```bash
bench --site add-desk-page --app
```
Follow the prompt to select the framework of your choice and **everything will be setup for you auto-magically**! Once the setup is done, the page will be opened up in the browser.
> Note: Restart your bench to get auto-reload on file changes for your custom app
## Building for Production
The below command builds the application and places it in the `www` directory of your frappe app:
```bash
cd && yarn build
```
Check the `package.json` file inside the Vue application directory to learn more about the dev server / build steps.
If you already have a package.json file with scripts in your app's root directory, you can add the following two scripts to your app's package.json file in order for the `bench build` command to work as expected:
```json
"dev": "cd && yarn dev",
"build": "cd && yarn build"
```
### License
[MIT](./license.txt)