Skip to content

Getting started

Kizlo Taras edited this page Oct 23, 2020 · 1 revision

Overview

Before starting verify you have all required tools installed and configured.

Tools

Environment

Machine setup

Install this tools for better developing experience:

Configure

SwitchStartupProject

If you are using VisualStudio you can download this extensions that simplifies selecting multiple projects.

To use it, you need to setup its configuration file - PostOffice.sln.startup.json.

.env

The .env file is used to define environment variables that will be applied before starting any project in the solution. It is a file tool to override values for any common configuration settings like connection strings.

setup.cmd

The .env and PostOffice.sln.startup.json file is not stored in git repository and you have to create them on your own. Use .env.sample and PostOffice.sln.startup_sample.json files correspondingly as a samples.

Use scripts/setup.cmd to create initial version of .env and PostOffice.sln.startup.json. The script is basically just copying the sample files.

Verify that you have correct values for connection strings. You are allowed to do any changes in .env and PostOffice.sln.startup.json.

Note services use IP address of your virtual machine. To find it out type docker-machine ip in console

Restore dependencies

Use scripts/init.cmd to restore dependencies on client and server sides.

Build

Use scripts/build.cmd to build all projects in solution.

To build solution for developing purpose open PostOffice.sln in VisualStudio and press ctrl + shift + B

Run

  • Start all required services. Run Infrastructure/runall.cmd
  • Start all required projects. Run script/runall.cmd

Run develop

  • Start all required services. Run Infrastructure/runall.cmd
  • Run API server in VisualStudio or with console dotnet run --project PostOffice.API
  • Run SmsSender service in VisualStudio or with console func start
  • Run Angular server with console npm run start

Clone this wiki locally