/AloPal

Primary LanguageJavaScript

#AloPal


Requirements

This project requires Node.js v8.0+ to be installed locally. A global install of Yarn or Npm is also recommended.


Installation

To get the project up and running, and view components in the browser, complete the following steps:

  1. Download and install Node: https://nodejs.org/
  2. Clone this repo: git clone git clone https://pooryak@bitbucket.org/Alopalnet/frontend.git (HTTPS)
  3. Install project dependancies: yarn install. (the server is down and the project can not build repository folder)

Development

When developing components, you may want assets automatically compiled and the browser to refresh automatically. To do this, run the following task:

$yarn dev

Creating a static build

To create a static instance of this project, run the following task:

$yarn build

Document

Project documentation is located in AloPal-doc folder , move to it and run yarn start.