Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include default client plugins (editing, qplotly, qtimeseries) as git submodules #301

Closed
wants to merge 2 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add default G3W-CLIENT plugins with submodules
volterra79 committed Jan 13, 2023
commit d1e2fd50e926994ca579ef46a6d79371ce178ae5
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -20,4 +20,9 @@ package-lock.json
/src/libs/sdk/config/dev/
/src/libs/sdk/g3w-ol3/config/config.js
/src/plugins/**
#exlude submodules folder of g3w-client default plugins
!/src/plugins/editing
!/src/plugins/qplotly
!/src/plugins/qtimeseries

!/src/plugins/README.md
9 changes: 9 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[submodule "src/plugins/qplotly"]
path = src/plugins/qplotly
url = https://github.com/g3w-suite/g3w-client-plugin-qplotly.git
[submodule "src/plugins/qtimeseries"]
path = src/plugins/qtimeseries
url = https://github.com/g3w-suite/g3w-client-plugin-qtimeseries.git
[submodule "src/plugins/editing"]
path = src/plugins/editing
url = https://github.com/g3w-suite/g3w-client-plugin-editing.git
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -127,14 +127,25 @@ http://localhost:3000/en/map/eleprofile/qdjango/2 # g3w-client (development)
If you want develop custom plugins you need to place them in the [`src/plugins`](https://github.com/g3w-suite/g3w-client/blob/dev/src/plugins) folder, below you can see some examples:

- [base-template](https://github.com/g3w-suite/g3w-client-plugin-base-template)
- [editing](https://github.com/g3w-suite/g3w-client-plugin-editing)
- [eleprofile](https://github.com/g3w-suite/g3w-client-plugin-elevation-profile)
- [openrouteservice](https://github.com/g3w-suite/g3w-client-plugin-openrouteservice)
- [qplotly](https://github.com/g3w-suite/g3w-client-plugin-qplotly)
- [qtimeseries](https://github.com/g3w-suite/g3w-client-plugin-qtimeseries)
- [queryresult-template](https://github.com/g3w-suite/g3w-client-plugin-queryresult-template)
- [sidebar-template](https://github.com/g3w-suite/g3w-client-plugin-sidebar-template)

### Default Plugins

- [editing](https://github.com/g3w-suite/g3w-client-plugin-editing)
- [qplotly](https://github.com/g3w-suite/g3w-client-plugin-qplotly)
- [qtimeseries](https://github.com/g3w-suite/g3w-client-plugin-qtimeseries)

To install Default G3W-SUITE plugin run follow command:

```sh

git submodules init # to initialize your local configuration file
git submodule update # to fetch all the data from that project and check out the appropriate commit listed in your project
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@volterra79 on which git version did you test the above commands?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Raruto git version 2.17.1

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've read about different "default" behaviors depending on the installed version, actually mine are:

git version 2.39.0.windows.2 # windows 10
git version 2.34.1           # windows subsystem for linux (ubuntu jammy)

Just to know, have you already updated your git version to the latest available on your OS?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Raruto yes. I'm working on Ubuntu 18.04.6 LTS


```
---

### FAQ
13 changes: 10 additions & 3 deletions config.template.js
Original file line number Diff line number Diff line change
@@ -6,9 +6,16 @@ const G3W_ADMIN_PORT = '8000'; // G3W-ADMIN development server
const G3W_CLIENT_PORT = '3000'; // G3W-CLIENT development server

const G3W_PLUGINS = [ // override "initConfig->group->plugins" attribute for custom plugin development
// "your-plugin-folder-name-1",
// "your-plugin-folder-name-2",
// "your-plugin-folder-name-3",
// "<plugin-name>": {
// <custom plugin configuration>
// }
/**
* Example:
* 'editing': {
* baseurl: '../dist',
* gid: 'qdjango:1'
* }
*/
];

const G3W_KEYS = {
1 change: 1 addition & 0 deletions src/plugins/editing
Submodule editing added at 1c3839
1 change: 1 addition & 0 deletions src/plugins/qplotly
Submodule qplotly added at bb4687
1 change: 1 addition & 0 deletions src/plugins/qtimeseries
Submodule qtimeseries added at d6ff85