Skip to content

Latest commit

 

History

History
133 lines (85 loc) · 4.47 KB

README.md

File metadata and controls

133 lines (85 loc) · 4.47 KB

Cordova and Next.js. Optional - Framework7

Use this package if you want to configure an application running Next, Cordova, optionally Framework 7. Real-time development mode on an emulator device, phone, browser. This package allows you to test in real time, write code together with plugins. And only after changing/refining the plugin code will the application need to be recompiled. Therefore, you can write code calmly, with ready-made plugins in real time on the emulator with a quick page reload. In addition, this package has a full extension that allows you to use other packages of the framework without resorting to global changes. It is enough to remove some unnecessary details. Added support (starting from version 0.0.4) for the Android - ADB platform. There is no ADB implementation server in this package, so it must be pre-installed on your computer. This is a client for the Android Debug Bridge server.

You can help the project with the amount in Telegram: @bymagnum

Install

npm install cordova-next -g

or

yarn global add cordova-next

Available platforms

Platform Description
web ☑ Available during development
android ☑ (Work is underway)
ios ☐ (Work is underway)
electron ☑ (Work is underway)

Platforms that are not marked require improvement

Steps required

Run the command that will create in the current directory all the necessary tools to work with the application:

nc create

Available commands

Command Description
nc create [option] Creates an application of the current directory, ready to work
nc dev <platform> Running two development servers, on http and https. The application installed for development listens to https
nc build <platform> Building a project for deployment on a device for further dev mode development
nc run <platform> Full build of the debug version project
nc release <platform> Complete project build for release (Work is underway)
nc platform <action> <platform> Add / remove a platform
nc plugin <action> <plugin> Add / remove a plugin

 

Platform Description
web ☑ Available during development
android ☑ (Work is underway)
ios ☐ (Work is underway)
electron ☑ (Work is underway)

 

Options Description
-f7, --framework7 Add Framework7 (Available nc create)

 

Action Description
add Add
remove Remove

   

cordova-next as a library

You can use the package as a library. At the moment, only the following React components are available:

import { ScriptCordova } from 'cordova-next';
<ScriptCordova />

Imports cordova.js, a good option for using a component in one place is _document.js, but it is also possible to use it at your discretion, up to complete deletion, if you do not need it as a system script.

In the process of development, nc dev web - cordova.js is not embedded in the page, while allowing you to easily develop an application in the browser. At the same time, you do not need to perform additional actions to remove the embedded component from the page.

 

Package.json in the deployed application

Parameter Default Description
nc.port.http 9090 Development port http
nc.port.https 9091 Development port https
nc.electron.browserWindow Cordova Electron Electron options
nc.electron.browserWindowInstance.loadURL.url index.html Except for the development mode, the default page is

   

General information

You can add all other commands directly to your package by applying npx.

Commands that you can add:

  1. Cordova

  2. NextJS

  3. Use the documentation for building the application Framework7

Do not try to create an application again using the "create next-app" or "cordova create" commands, everything you need is already present in this package, and you only need to work on your application.

Everything else - You can use it as if you used cordova, next, framework 7 separately.

Two servers are used in this package for the following purposes: WebRTC requires an SSL connection, as well as several other technologies that require a secure connection and do not allow development without SSL. Https is also a direct working ready-made tool.