github

For Developers

Prerequisites

Docker Desktop

https://www.docker.com/products/docker-desktop/

NodeJS 14

https://nodejs.org/download/release/latest-v14.x/

Yarn

npm install --global yarn

Git

(https://git-scm.com/downloads)

---

Setting up the environment

Clone the repository:

git clone https://github.com/pipecraft2/pipecraft

Install and run:

cd pipecraft
yarn run install_pipe
yarn electron:serve

---

Developer tools

The apps front-end desing, data storage and navigation are built using the Vue framework and its plugins. To build new or to modify exiting components will reiqure a some proficiency in JavaScript and the Vue framework.

Other important tools include electron which is mainly used for interacting with the file system and dockerode which is used for controlling docker.

Electron 13:

https://www.electronjs.org/

Vue 2:

https://v2.vuejs.org/v2/guide/

Vuetify 2:

https://v2.vuetifyjs.com/en/introduction/why-vuetify/#what-is-vuetify3f

Vue Router 3:

https://v3.router.vuejs.org/guide/

Vuex 3:

https://v3.vuex.vuejs.org/#what-is-vuex

dockerode:

https://github.com/apocas/dockerode

Note

All of these tools are automatically installed during the install_pipe command.

---