Skip to content
Matthew Pirocchi edited this page Jan 14, 2017 · 11 revisions

Getting started

Dependencies

  • node.js. You can download it from nodejs.com, or install it through your favorite package manager (i.e. apt-get install node).

  • Once node.js is installed, navigate to the root of this repository and run npm install to install all remaining dependencies.

    cd /my/repos/cardinal
    npm install
    

Running in development mode

cd /my/repos/cardinal
npm start

Then navigate to http://localhost:8080 in your browser.

Building for production

cd /my/repos/cardinal
npm run production 

Deploying

All of Cardinal's logic is in the client, and it uses Google Firebase for the backend, so all you need is a static web server. Just upload the contents of /my/repos/cardinal/production to your favorite static web server (or use the suggestions from the 'Useful links' section below.

Useful links:

Public

Private

These are the services that I use to host cardinal. If you're interested in hosting your own instance of Cardinal, this is a good place to start.

Clone this wiki locally