Skip to content

N4SJAMK/teamboard-client

Repository files navigation

Teamboard

Teamboard is the next level of Internet.

Dependencies

The client depends on both the teamboard-io, and teamboard-api being installed and running. Please refer to their respective guides for installation.

Installation

npm install N4SJAMK/teamboard-client

Setup

You need to have a few variables set before building the distribution.

NODE_ENV has to be set to production if you are setting the other variables manually. If set to development, the client will try to connect to services running on localhost. When set to production, you must declare the other environmental variables with valid values.

  • API_URL and API_PORT correspond to the teamboard-api host and port
  • IO_URL and IO_PORT correspond to the teamboard-io host and port
  • STATIC_URL and STATIC_PORT correspond to where screenshots and stuff are hosted. Currently the static contet is being hosted by teamboard-api.
  • HOSTNAME can be set if you want to test on IPad or something similar. This will mean that the gulp default task will run the server with the given hostname and that the application will try and connect to the given hostname for the teamboard-api and teamboard-io services.

Once you have set the required variables if any. You can build the distribution with the command gulp build. If you have set the environment to production, the app will use a minified version of the javascript. The result of the gulp build command will give you a dist folder that you need to serve with something like nginx.