Skip to content

Commit

Permalink
Merge pull request #1 from ColinEberhardt/minor-fixes
Browse files Browse the repository at this point in the history
Minor fixes
  • Loading branch information
nkolba authored Mar 17, 2022
2 parents ff769b3 + 1766775 commit 7db719e
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 3 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]
Copyright 2022 Nick Kolba

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,32 @@ The local appD will run at `localhost:8080` by default.

By default, the Desktop Agent points to the local directory in development and to the `https://appd.kolbito.com` directory in production. You can change the local settings in `scripts/watch.js` by modifying the entries for `VITE_DEV_DIRECTORY_URL` and change the production setting by modifying the value for `productionDirectory` in `packages/main/src/utils.ts`.

## Commands
## Getting Started

Install dependencies:

~~~
npm install
~~~

Build and run the app directory:

~~~
npm run build:directory
npm run start:directory
~~~

This will run a local App Directory on port 8080.

Start the FDC3 application:

~~~
npm start
~~~

Other useful commands:

1. `npm start` / `npm run watch` - Start the Electron app in dev mode.
1. `npm run start:directory` - Start the local app directory.
1. `npm run compile` - Build the app for local debugging only.
1. `npm run lint` - Lint the code.
1. `npm run typecheck` - Run a TypeScript check.
Expand Down

0 comments on commit 7db719e

Please sign in to comment.