Skip to content

Latest commit

 

History

History
100 lines (68 loc) · 5.11 KB

client.md

File metadata and controls

100 lines (68 loc) · 5.11 KB

Client Application

Download

The client application is available for download from the latest GitHub release page.

There are three files available for download:

  1. appsettings.json: The default configuration file. See the default configuration file.
  2. npgsqlrest-linux64: Linux64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Linux 64x systems.
  3. npgsqlrest-win64.exe: Windows64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Windows 64x systems.

NPM

Installation is possible via the NPM package manager:

npm install npgsqlrest --save-dev

The NPM package will download on installation the appropriate executable binary for your target operating system. The command will be available with the NPX runner:

$ npx npgsqlrest [arguments]

See usage for more info.

Custom Builds

The client application was built from the NpgsqlRestClient project directory.

To create a custom build follow these steps:

  1. Make sure that you have .NET8 SDK installed and ready.
  2. Clone NpgsqlRest repository
  3. Navigate to the NpgsqlRestClient project directory.
  4. Make your desired customizations (or not).
  5. Run publish command, for example, dotnet publish -r win-x64 -c Release --output [target dir]

Notes: win-x64 is the designated target OS for the build. Adjust this parameter appropriately for the target OS. See https://learn.microsoft.com/en-us/dotnet/core/rid-catalog#known-rids. The project is already configured for the AOT builds, but you will need to run the publish command from the same flavor OS as the build target OS (Windows for Windows builds, Linux for Linux builds, etc).

MacOS Builds

The Mac OS builds are missing because I don't have a Mac machine. If someone could help me out with this I'd be grateful.

Features

  • Create an Automatic REST API for the PostgreSQL Databases.
  • Generate TypeScript Code and HTTP files for testing.
  • Configure security for use the of either encrypted cookies or JWT Bearer tokens or both.
  • Expose REST API endpoints for the PostgreSQL Databases as Login/Logout.
  • Use external authentication providers such as Google, LinkedIn or GitHub.
  • Server static content.
  • Use and configure built-in Serilog structured logging.
  • Configure Cross-origin resource sharing (CORS) access, SSL, Server Certificates and more, everything needed for modern Web development.

See the default configuration file with descriptions for more information.

Usage

❯ npgsqlrest --help
Usage:
npgsqlrest                               Run with the optional default configuration files: appsettings.json and
                                         appsettings.Development.json. If these file are not found, default
                                         configuration setting is used (see
                                         https://vb-consulting.github.io/npgsqlrest/config/).
npgsqlrest [files...]                    Run with the custom configuration files. All configuration files are required.
                                         Any configuration values will override default values in order of appearance.
npgsqlrest [file1 -o file2...]           Use the -o switch to mark the next configuration file as optional. The first
                                         file after the -o switch is optional.
npgsqlrest [file1 --optional file2...]   Use --optional switch to mark the next configuration file as optional. The
                                         first file after the --optional switch is optional.
Note:                                    Values in the later file will override the values in the previous one.

npgsqlrest [--key=value]                 Override the configuration with this key with a new value (case insensitive,
                                         use : to separate sections).

npgsqlrest -v, --version                 Show version information.
npgsqlrest -h, --help                    Show command line help.


Examples:
Example: use two config files            npgsqlrest appsettings.json appsettings.Development.json
Example: second config file optional     npgsqlrest appsettings.json -o appsettings.Development.json
Example: override ApplicationName config npgsqlrest --applicationname=Test
Example: override Auth:CookieName config npgsqlrest --auth:cookiename=Test

Changelog

Changelog has been moved to main changelog file: Changelog

Note: The changelog for the older version for client can be found here: Changelog Archive