Skip to content

Building-from-sources.md

Latest commit

 

History

History
78 lines (46 loc) · 2.19 KB

Building-from-sources.md

File metadata and controls

78 lines (46 loc) · 2.19 KB

Building Financial App from sources

If you like to build Financial App from sources, you can follow the instructions below.

Prequisites

Additional prequisites on Windows

  • Powershell 5.x

Additional prequisites on Linux (Ubuntu)

  • Powershell Core (for building mail templates)

Environment:

  • Ensure yarn and node are in your PATH.
  • Ensure dotnet is in your PATH.

For running the build script:

  • Ensure the Powershell execution policy is set to RemoteSigned.

Check-out

Pull the sources from this repository's home page.

Building

Use the build script in the root to build the application:

build

To create a deployment to one of the supported platforms:

build -Target Publish

The results will be emitted in the build/publish folder. For additional supported command line parameters run:

build -h

Development

After you've build the application once you can start developing.

To develop, just run the application using dotnet run. The webpack development middleware will automatically compile and serve any frontend dependencies.

If you have not created a database yet, please run build -Target Generation-MigrationScript to generate a migration script and run it on a local database.

Code style and linting

Code style and linting of TS/JS/JSON is enforced via TSLint and Prettier. If you have run yarn, prettier will be run as a pre-commit hook.

Editors

Both Visual Studio and Visual Studio Code work well with the project.

Recommended extensions for Visual Studio:

Recommende extensions for Visual Studio Code:

  • Editor support
    • csharp
  • Code formatting and linting
    • tslint
    • vscode-prettier
    • vscode-status-bar-format-toggle
  • Email template editing:
    • vscode-mjml
    • mjml-syntax