Skip to content

Latest commit

 

History

History
116 lines (76 loc) · 3.13 KB

README.md

File metadata and controls

116 lines (76 loc) · 3.13 KB

npm version code style: prettier

Peppubuild-CLI

This is the official CLI for peppubuild. If you want to bootstrap your own self-hosted version of Peppubuild speedily without using our cross-platform desktop application, you're in the right place.

Prerequisites

This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
6.4.1
v8.16.0

Table of contents

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installation

BEFORE YOU INSTALL: please read the prerequisites

Start with installing Peppubuild locally on your local machine:

$ npm i -g peppubuild

Now, run the Peppubuild command in your terminal.

$ peppubuild

You'll be asked the question below:

Do you want to install a self-hosted version of peppubuild?

Respond with 'y' and hit the enter button, a Peppubuild folder will be created.

Usage

Serving the app

Navigate to the peppubuild folder that was just created.

$ cd peppubuild

Next run the install command.

npm install

Finally, we can serve the application using the command below:

npm run start

More Information

If you need more information on how to use Peppubuild, checkout the Peppubuild Repository.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Add your changes: git add .
  4. Commit your changes: git commit -am 'Add some feature'
  5. Push to the branch: git push origin my-new-feature
  6. Submit a pull request 😎

Built With

  • NodeJS

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Ukpai Ugochi - Initial work - Ugochi

See also the list of contributors who participated in this project.

License

MIT License © Andrea SonnY