Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 930 Bytes

contributing.md

File metadata and controls

41 lines (30 loc) · 930 Bytes

Contributing

  1. Install Node. Download the "Recommend for Most Users" version.

  2. Clone the repo:

git clone [email protected]:glorious-codes/glorious-pitsby.git
  1. Go to the project directory
cd glorious-pitsby
  1. Install the project dependencies
npm install

  1. Create the pitsby.config.js and, at least, one *.doc.js in a third party project.

  2. Install and run Pitsby on the root directory of the project previously cited according to the Basic Usage instructions.

  3. If you want just to build the project, run:

npm run build
  1. Otherwise, run:
npm run start

The app will be running on http://localhost:8080 and the browser will automatically reload with the changes you make in any source file.

Tests

  1. Ensure that all code that you have added is covered with unit tests:
npm run test -- --coverage