chore: add LICENSE and README

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Bram Borggreve https://github.com/beeman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,76 +1,61 @@
-# PubkeyUiStarter
+# PubKey UI Starter
 
-<a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a>
+Starter for a [PubKey UI](https://github.com/pubkeyapp/pubkey-ui) project.
 
-✨ **This workspace has been generated by [Nx, Smart Monorepos · Fast CI.](https://nx.dev)** ✨
+> [!WARNING]  
+> PubKey UI is unstable, there can be minor and major changes at any time.
 
-## Integrate with editors
+## Getting Started
 
-Enhance your Nx experience by installing [Nx Console](https://nx.dev/nx-console) for your favorite editor. Nx Console
-provides an interactive UI to view your projects, run tasks, generate code, and more! Available for VSCode, IntelliJ and
-comes with a LSP for Vim users.
+### Prerequisites
 
-## Nx plugins and code generators
+- [Node.js](https://nodejs.org/en/) (v20 or higher)
+- [PNPM](https://pnpm.io/) (v8 or higher)
+- [Git](https://git-scm.com/)
 
-Add Nx plugins to leverage their code generators and automated, inferred tasks.
+> [!TIP]
+> If you don't have PNPM installed, you can install it using `corepack`:
+>
+> ```sh
+> corepack enable
+> corepack prepare pnpm@8 --activate
+> ```
 
-```
-# Add plugin
-npx nx add @nx/react
-
-# Use code generator
-npx nx generate @nx/react:app demo
+### Installation
 
-# Run development server
-npx nx serve demo
+1. Clone the repository:
 
-# View project details
-npx nx show project demo --web
+```sh
+git clone https://github.com/pubkeyapp/pubkey-ui-starter my-app
+cd my-app
+pnpm install
 ```
 
-Run `npx nx list` to get a list of available plugins and whether they have generators. Then run `npx nx list <plugin-name>` to see what generators are available.
-
-Learn more about [code generators](https://nx.dev/features/generate-code) and [inferred tasks](https://nx.dev/concepts/inferred-tasks) in the docs.
-
-## Running tasks
+### Development
 
-To execute tasks with Nx use the following syntax:
-
-```
-npx nx <target> <project> <...options>
+```sh
+pnpm dev
 ```
 
-You can also run multiple targets:
+### Build
 
-```
-npx nx run-many -t <target1> <target2>
+```sh
+pnpm build
 ```
 
-..or add `-p` to filter specific projects
+### Lint
 
-```
-npx nx run-many -t <target1> <target2> -p <proj1> <proj2>
-```
-
-Targets can be defined in the `package.json` or `projects.json`. Learn more [in the docs](https://nx.dev/features/run-tasks).
-
-## Set up CI!
-
-Nx comes with local caching already built-in (check your `nx.json`). On CI you might want to go a step further.
+```sh
 
-- [Set up remote caching](https://nx.dev/features/share-your-cache)
-- [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution)
-- [Learn more how to setup CI](https://nx.dev/recipes/ci)
-
-## Explore the project graph
+pnpm lint
+```
 
-Run `npx nx graph` to show the graph of the workspace.
-It will show tasks that you can run with Nx.
+### Test
 
-- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph)
+```sh
+pnpm test
+```
 
-## Connect with us!
+## License
 
-- [Join the community](https://nx.dev/community)
-- [Subscribe to the Nx Youtube Channel](https://www.youtube.com/@nxdevtools)
-- [Follow us on Twitter](https://twitter.com/nxdevtools)
+MIT

package.json

@@ -3,7 +3,10 @@
   "version": "0.0.0",
   "license": "MIT",
   "scripts": {
-    "dev:web": "nx run web:serve"
+    "build": "nx run web:build",
+    "dev": "nx run web:serve",
+    "lint": "nx run-many --target=lint --all",
+    "test": "nx run-many --target=test --all"
   },
   "private": true,
   "devDependencies": {

web/src/app/app.spec.ts

@@ -0,0 +1,5 @@
+describe('App', () => {
+  it('should be true', () => {
+    expect(true).toBe(true)
+  })
+})