# drup > Project and environment manager utility. Latest version **0.1.8** (published 2018-01-16) · MIT license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install drup pnpm add drup yarn add drup bun add drup ``` Provides the command `drup`. ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 0.1.8 | | Published | 2018-01-16 | | First published | 2017-03-07 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >= 7.6 | | Dependencies | 16 | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 3 | | Author | _Archy_ | | Maintainers | fzuzzy | ## Links - npm: https://www.npmjs.com/package/drup - Repository: https://github.com/archfz/drup - Homepage: https://github.com/archfz/drup#readme - Issues: https://github.com/archfz/drup/issues - npm.io page: https://npm.io/package/drup ## Dependencies (16) - [dot](https://npm.io/package/dot.md) ^1.1.1 - [charm](https://npm.io/package/charm.md) ^1.0.1 - [upath](https://npm.io/package/upath.md) ^1.0.0 - [colors](https://npm.io/package/colors.md) ^1.1.2 - [js-yaml](https://npm.io/package/js-yaml.md) ^3.10.0 - [process](https://npm.io/package/process.md) ^0.11.9 - [request](https://npm.io/package/request.md) ^2.83.0 - [fs-extra](https://npm.io/package/fs-extra.md) ^2.0.0 - [inquirer](https://npm.io/package/inquirer.md) ^1.2.2 - [readdirp](https://npm.io/package/readdirp.md) ^2.1.0 - [fs-promise](https://npm.io/package/fs-promise.md) ^1.0.0 - [is-git-url](https://npm.io/package/is-git-url.md) ^0.2.3 - [strip-ansi](https://npm.io/package/strip-ansi.md) ^3.0.1 - [path-is-inside](https://npm.io/package/path-is-inside.md) ^1.0.2 - [moment-timezone](https://npm.io/package/moment-timezone.md) ^0.5.13 - [escape-string-regexp](https://npm.io/package/escape-string-regexp.md) ^1.0.5 ## Recent versions - 0.1.8 (latest) — 2018-01-16 - 0.0.1 (alpha) — 2017-03-07 - 0.1.7 — 2017-09-29 - 0.1.6 — 2017-09-15 - 0.1.5 — 2017-09-11 - 0.1.4 — 2017-09-11 - 0.1.3 — 2017-08-12 - 0.1.2 — 2017-08-12 - 0.1.1 — 2017-08-07 - 0.1.0 — 2017-08-07 - 0.0.11 — 2017-05-15 - 0.0.10 — 2017-05-15 - 0.0.9 — 2017-05-15 - 0.0.8 — 2017-05-15 - 0.0.7 — 2017-05-11 - … 5 more at https://npm.io/package/drup/versions ## README Drup logo # DRUP Drup is a command line utility that helps to kick-start development on your projects. It allows you to configure an environment and by leveraging the power of [Docker](https://www.docker.com/) it builds it for you. All configuration get stored in a yaml file that if shared can be reused to build the same environment. ## Features - creating new project with environment - cloning or registering existing project - automatically creating environment when configuration detected - adding hosts aliases to exposed services - keeping track of all projects registered locally ## Requirements | | | |------------------|--------------------------| |[**GIT**](https://git-scm.com/downloads) | GIT is required to clone projects with drup. |[**NodeJS**](https://nodejs.org/en/download/current/) | Drup is built upon Node. **Version >= 7.5** is required. |[**Docker**](https://docs.docker.com/engine/installation/) | Drup uses docker to create virtual systems. |[**DockerCompose**](https://docs.docker.com/compose/install/) | Drup heavily makes use of the docker extended functionality. ## Platforms As drup has been built upon [NodeJS](https://en.wikipedia.org/wiki/Node.js) it should support all major operating systems. Currently only the following were tested: - **UBUNTU**: mainly targeted, works best - **WINDOWS 10**: supported, but slow (not recommended) ## Installation **NOTE**: Admin privileges are required because drup provides a a global executable that has to be created upon installation. ```bash sudo npm --global install drup ``` After you ran the above command 'drup' should be available in your PATH. Run 'drup ?' to get started. You can also get help for operations by appending the question mark (ex: 'drup create ?'). ## Available support for ##### SERVICES: | | | |------------------|--------------------------| | **Interpreters** | PHP, NodeJS | | **WEB servers** | Apache, Nginx, LightTPD | | **Database** | MySQL, MariaDB, PMA | | | | ##### PROJECT TYPES: | Type | Provided services | |--------------|--------------------------| | **Drupal** | Drush | | | | ## Example usage You can use the following steps to learn the basic usage of drup. 1. Start by creating a new project. This will download Drupal files and initiate a fresh website. ```bash sudo drup create drupal ``` 2. You will be asked to input some simple information, just follow along and read carefully the descriptions for each input. 3. After you have gone through the last command you will a registered project. You can check this by running the following command: ```bash drup list ``` - This will display all registered projects. Each project has it's key in front and after that the project name. 4. To list all the details of your project and it's environment first note the project ID and then run the following command (replace ): ```bash drup info ``` - You will need this to take note of the database name and the database container hosts alias so that you can do the installation of Drupal. 5. After this you can start the project. This can take a long time depending on whether your docker already has the required images downloaded or not. Also this is the phase when drup does additional installs, like composer install. ```bash sudo drup start ``` 6. After the project has started you can visit the domain aliases that got printed. At this step install the Drupal website. You might have to create directories or set permissions. 7. Now just do a configuration dump. ```bash sudo drup drush cex ``` ## Details ### Services Services are at the base of the functionality. By combining and configuring these you create your environments. Services can provide additional operations so that you don't have to manually execute commands in containers. These basically create your container configuration. ### Projects Drup provides building and starting mechanism for defined project types. These project handlers define service requirements/ possibilities and default environment configuration. They also add custom services and installation methods to start anew. ## Contribution Drup is **open source**. Anyone is welcome to contribute, be it that is by **testing**, creating **issues** of **bugs** or **suggestions** or even better **writing code**. Documentation for coders is not yet available, you will have to discover the backend yourself :D. --- _Source: https://npm.io/package/drup · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._