# build-project-tool

> Build a Laravel, Javascript, or Wordpress project quickly.

Latest version **1.1.0** (published 2021-02-09) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install build-project-tool
pnpm add build-project-tool
yarn add build-project-tool
bun add build-project-tool
```

Provides the command `build-project`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2021-02-09 |
| First published | 2020-01-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 200.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Justintime50 |
| Maintainers | justintime50 |
| Keywords | build, project, laravel, node, wordpress, javascript, shell, python |

## Links

- npm: https://www.npmjs.com/package/build-project-tool
- Repository: https://github.com/Justintime50/build-project
- Homepage: https://github.com/Justintime50/build-project#readme
- Issues: https://github.com/Justintime50/build-project/issues
- npm.io page: https://npm.io/package/build-project-tool

## Dependencies (5)

- [fs](https://npm.io/package/fs.md) 0.0.1-security
- [chalk](https://npm.io/package/chalk.md) ^3.0.0
- [clear](https://npm.io/package/clear.md) ^0.1.0
- [figlet](https://npm.io/package/figlet.md) ^1.2.4
- [inquirer](https://npm.io/package/inquirer.md) ^7.0.3

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2021-02-09
- 1.0.0 — 2020-09-15
- 0.4.0 — 2020-01-21
- 0.3.0 — 2020-01-21
- 0.2.0 — 2020-01-18
- 0.1.0 — 2020-01-17

## README

<div align="center">

# Build Project

Opinionated boilerplate setup for all your favorite languages and frameworks.

[![Build Status](https://github.com/Justintime50/build-project/workflows/build/badge.svg)](https://github.com/Justintime50/build-project/actions)
[![Coverage Status](https://coveralls.io/repos/github/Justintime50/build-project/badge.svg?branch=main)](https://coveralls.io/github/Justintime50/build-project?branch=main)
[![NPM](https://img.shields.io/npm/v/build-project-tool)](https://www.npmjs.com/package/build-project-tool)
[![Licence](https://img.shields.io/github/license/justintime50/build-project)](LICENSE)

<img src="assets/showcase.png" alt="Showcase">

</div>

## What Can it Do?

Build Project can setup a variety of projects for you saving precious time when starting a new project. Build Project has the following features:

1. Create a `new directory`
1. Initiate a `git repo`
1. Generate a `.gitignore file`
1. Generate a `README.md file`
1. Generate a `LICENSE file`
1. Generate a `Dockerfile` and/or `docker-compose.yml file`
1. Setup your choice of project
    - **Laravel:** Initiate a Laravel project, install packages, publish the storage directory, and scaffold the authentication system.
    - **Node:** Initiate an NPM `package.json` file, `index.js` file, and install dev dependencies such as `eslint`, `mocha`, `coveralls`, and more.
    - **Python:** Create an `__init__.py` file and a `setup.py` file with dev dependencies such as `flake8`, `pytest`, and more.
    - **Wordpress:** Download and unzip Wordpress.
    - **Shell:** Create an executable script file.
    - **Custom:** Build Project will not create an opinionated boilerplate.

## Prerequisites

Build Project requires the following for certain features of the tool. Without them, your builds may fail.

- Git
- Node/NPM
- PHP/Composer
- Python
- Curl

## Install

```bash
npm i -g build-project-tool
```

## Usage

Navigate to the folder where you want to create your project, then run the command:

```bash
build-project
```

Follow the prompts to build a variety of projects.

## Development

```shell
# Install the project locally
npm i

# Lint files
npx eslint index.js

# Run tests
npm run test
```

---
_Source: https://npm.io/package/build-project-tool · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._