Scheduling and Listing Front-end

Quick start

# install the dependencies with Yarn
$ yarn install

# start the development server
$ yarn start

go to http://localhost:3451 in your browser.

Table of Contents

• Prerequisites
• Install dependencies
• Running
• Testing
• Production
• Documentation

Prerequisites

• Node.js >= v8.0.0
• yarn
• Docker

You can use NVM (Node Version Manager) to get proper Node version

Install dependencies

The project uses yarn.

To install dependencies please execute the following command:

yarn install

Running

Simply run:

yarn start

to start the SNL app on http://localhost:3451.

And you are all set! You can now modify your components on the fly without having to reload the entire page.

Docker

If you want your code to become available to other Docker projects (e.g. for local environment testing), you need to build the app and then the Docker image:

// Note: 'build' - will build the angular app, 'ssr' will build the node js app so both are needed in order to run app on docker.
yarn build:ssr
docker-compose build

You can run it by executing following command:

docker-compose up

As a result, the SNL frontend app will be started and made available on port 3451.

Testing and Preparing for Pull Requests

Before creating a PR, ensure that all of the code styling checks and tests have been done locally (they will be caught on Jenkins if there are any discrepancies)

1. Code Style

• run: yarn lint

2. Unit Tests

• single run: yarn test
• live mode (TDD style): yarn test-watch

3. E2E Tests

• single run: yarn test:functional

You can change target URL by changing the e2e-url.js. In this file there are two configurations already: local, and ATT. Uncomment this configuration that you would like to use. E2E tests generates screenshot on failure. Output is stored in functional-output directory.

Production

To build your application, run:

• yarn build

You can now go to /dist and deploy that to your server!

Documentation

You can generate api docs (using TypeDoc) for your code with the following:

• yarn docs

LICENSE

This project is licensed under the GPL-3 License - see the LICENSE file for details.