contributing.md

It's not another WordPress theme! It's a full website using WordPress API! I can't believe, sweet lord!! 🙌

Table of contents

• Download, install and config
• Goals
• Tests
• WordPress Rest API
• License

Download, install and config

First of all, make sure you have installed the main dependencies:

• Git
• NodeJS
• Gulp

# Clone or fork this repository. 
# If you wanna clone, run:
$ git clone [email protected]:frontpressorg/frontpress.git

# Install the dependencies
$ npm i

First time running the app:

Just run the command below and we'll create a configuration file called frontpress.json.

You may find more information about frontpress.json here.

$ npm run dev

Run this to use the watch code modifications and rebuild:

$ npm run watch

Wait a few, and it will open a new tab on your browser.

Goals

• Grade A on codacy

Tests

Initial configurations

• If your NodeJS version is < 5.0, then install NVM - Node Version Manager.
• Then install a 5.0+ version of NodeJS:

# Install a NodeJS version 5.0+ using nvm.
$ nvm install 5.0

# Using the installed version
$ nvm use 5.0

• Then, run the command below to execute all the tests.

$ karma start

• To run the tests while writing the code, just add the flag --no-single-run.