Skip to content
This repository has been archived by the owner on Aug 28, 2019. It is now read-only.

Latest commit

 

History

History
90 lines (66 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

90 lines (66 loc) · 1.86 KB

CONTRIBUTING

Installation

You first need to clone the project on your computer, and to install Node. This project also uses nvm.

From the command-line:

cd ~/Development/sites/
git clone [email protected]:springload/springtunes.git
cd springtunes

To install our dependencies:

nvm install
npm install --global eslint eslint-plugin-react babel-eslint eslint-config-airbnb
# Then, install all project dependencies.
npm install
# Optionally, install the git hooks.
./.githooks/deploy

Work on the project

Everything mentioned in the installation process should already be done.

# Start the server and the development tools.
npm run dev
# Compile SCSS
npm run build:css
# Runs linting.
npm run lint
# Runs tests.
npm run test
# Runs test watcher
npm run test:watch
# Check coverage
npm run test:coverage

Using the git hooks

Git hooks automatically check your code before every commit.

# To enable the hooks, from the project root:
./.githooks/deploy
# To disable the hooks for a single commit, use the appropriate flag:
git commit --no-verify

Deploying a new version

To production

To build:

npm run dist
npm run build:css

To run the server:

npm run start

Once server is running, access to it using: http://localhost:3000 or http://[YOUR IP]:3000

REST API Documentation

Populated using http://apidocjs.com/

apidoc -i ./server

Visit index.html inside /doc

To NPM

  • Make your changes on code base
  • Once you're sure everything is fine, npm version patch (will bump third number, i.e. 0.1.5 -> 0.1.6) or any other more appropriate argument (see https://docs.npmjs.com/cli/version)
  • git push origin master --tags
  • npm publish

This will publish the new version to NPM website (https://www.npmjs.com/package/springtunes)