Skip to content

Getting Started

Dave Bouman edited this page Sep 20, 2021 · 3 revisions

How to start working on the application

In this wiki we are going to explain the first steps you need to take for developing with Angular, getting the DeX application to work, and finally how to develop for the application.

What are we going to do:

  1. Setting up the local environment and workspace for Angular
  2. Cloning the repository and installing packages
  3. Working on the application
  4. (Optional) Running the backend services

Setting up the local environment and workspace for Angular

For your local environment and workspace you will need to install a few things first:

  1. An IDE of your choice
  2. Node.js
  3. an NPM package manager
  4. Configure Visual Studio Code

Follow the steps on https://angular.io/guide/setup-local to complete your setup. Make sure to test if you are able to create and open an application before you go to the next step.

Cloning the repository and installing packages

First we need to make sure you've got Git installed to be able to run Git commands. If you need to install Git, follow the steps on:https://git-scm.com/book/en/v2/Getting-Started-Installing-Git.

On your device of choice, navigate to the folder in which you would like to clone the repository. Once in the right folder, open your terminal of choice and clone the repository by using the following command.

  1. Clone the repo
git clone https://github.com/DigitalExcellence/dex-frontend.git
  1. Install NPM packages
npm install
  1. Open the folder with VS Code
  2. Open new terminal CTRL + SHIFT + ~
  3. Serve the application with the Angular CLI
npm start

Configure Visual Studio Code

The recommended editor for this project is Visual Studio Code. The following extensions are mandatory to use during developing:

The following list contains recommended plugins: Recommended plugins

The extensions can be imported with the use of the Visual Studio Code plugin Settings Sync

Running the backend services

To learn how to run the backend services please refer to this wiki article.