Skip to main content

Installation

Prerequisites​

  • Install Node.js 18 LTS version
  • Clone this repository

Setup​

To install the KoALa app on your local machine, open a terminal window and run the following command in the root folder of the KoALa app:

npm install

Start Frontend​

To run the frontend in development mode, run the following command in the root folder of the KoALa app:

nx serve koala-frontend

or

npm run start

Open the url http://localhost:4200 in a browser.

Start Backend​

To start the server in development / local mode, run the following command in the root folder of the KoALa app:

nx serve api

or

npm run start:api

You can check the GraphQL API through the GraphQL playground by opening the url http://localhost:3333/graphql in a browser.

Run Frontend and Backend Together​

npm run start:all

Generate GraphQL Angular Types/Requests​

To regenerate the client access objects to the GraphQL server based on the changes in the server, run the following commands in separate sessions in the root folder of the KoALa app (wait for the first command to start the server completely, because a running server is needed for the code generation to work):

nx serve api
npm run codegen

or

npm run start:api
npm run codegen

Execute E2E Tests​

First you need to start the KoALa server locally, because the end2end tests rely on a running server instance. You can do that by running the following command in your terminal (see also Start Backend)

nx serve api

or

npm run start:api