Norwegian Puffin Movies

    galaxy-api

    0.0.4 • Public • Published

    galaxy-api

    Here lies the REST API for Galaxy.

    Installation

    To install dependencies:

    npm install
    

    Node 0.11.x is required for the --harmony flag which enables generators (required for Koa, the web framework). If you're running an earlier version of Node you may install n, a node version manager to quickly install 0.11.x:

    npm install -g n
    n 0.11.12
    

    Development

    Initialise settings, if you haven't already:

    cp ./settings_local.js.dist ./settings_local.js
    

    Set these environment variables:

    NODE_ENV=development
    GALAXY_API_SETTINGS=./settings_local.js
    

    To run the local web server:

    nodemon --harmony bin/api
    

    Alternatively:

    npm run-script dev
    

    To run linting tools:

    gulp lint
    

    Production

    Initialise settings if you haven't already:

    cp ./settings_prod.js.dist ./settings_prod.js
    

    Set these environment variables:

    NODE_ENV=production
    GALAXY_API_SETTINGS=./settings_prod.js
    

    Node 0.11.x is required for the --harmony flag which enables generators (required for Koa, the web framework).

    To run the web server in production:

    node --harmony bin/api
    

    Alternatively:

    npm run-script prod
    

    Testing

    Initialise settings:

    cp ./settings_local.js.dist ./settings_local.js
    

    Set these environment variables:

    NODE_ENV=test
    GALAXY_API_SETTINGS=./settings_test.js
    

    To run tests:

    npm test
    

    Deployment

    To run the local web server:

    node --harmony bin/api
    

    Alternatively:

    npm start
    

    Keywords

    none

    Install

    npm i galaxy-api

    DownloadsWeekly Downloads

    2

    Version

    0.0.4

    License

    MIT

    Last publish

    Collaborators

    • cvan