build-project-tool

Build Project

Opinionated boilerplate setup for all your favorite languages and frameworks.

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
2. Initiate a git repo
3. Generate a .gitignore file
4. Generate a README.md file
5. Generate a LICENSE file
6. Generate a Dockerfile and/or docker-compose.yml file
7. 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

npm i -g build-project-tool

Usage

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

build-project

Follow the prompts to build a variety of projects.

Development

# Install the project locally
npm i

# Lint files
npx eslint index.js

# Run tests
npm run test

Changelog

v1.1.0 (2021-02-08)

• Removed Travis CI file from template
• Added README file to template
• Swapped Travis CI for GitHub Actions
• Bumped dependencies