Csl examples

.github/workflows/sonarqube.yml → .github/workflows/_sonarqube.yml_

@@ -21,6 +21,8 @@ jobs:
         fetch-depth: 0
     - name: SonarQube Scan
       uses: sonarsource/[email protected]
+      with:
+        projectBaseDir: "rust"
       env:
         SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
         SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}

example/.gitignore

@@ -1,3 +1,23 @@
-node_modules/
-dist/
-tsconfig.tsbuildinfo
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

example/.nvmrc

@@ -0,0 +1 @@
+v22.14.0

example/.prettierrc

@@ -0,0 +1,14 @@
+{
+  "printWidth": 120,
+  "trailingComma": "all",
+  "tabWidth": 2,
+  "useTabs": false,
+  "parser": "typescript",
+  "semi": true,
+  "singleQuote": true,
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "importOrder": ["^@(.*)$", "^[./]" ],
+  "importOrderSeparation": true,
+  "importOrderSortSpecifiers": true
+}

example/README.md

@@ -0,0 +1,42 @@
+# Example how to use the Cardano Serialization Lib
+
+The example includes the dApp with four basic operations:
+
+* Creating a simple transaction
+* Registering a wallet staking public key
+* Unregistering a wallet staking key
+* Vote delegation
+
+## Structure
+
+Everything related to the user interface (UI) is located in the folder `./src/components-ui`.
+
+The logic behind each operation is found in the folder `./src/components-logic` which has the same name.
+
+Commonly used functions are placed in the file `./src/componets-logic/core.ts`.
+
+### Example
+
+Let's take a look at the file `TransactionCreator.tsx`.
+
+It contains only UI and it is located in the folder `./src/components-ui`.
+
+All logic related to this file is placed in the file `TransactionCreator.ts`, which is located in the `./src/components-logic` folder.
+
+## Installation and running
+
+### Instalation
+
+To install the app, go to the `./example` folder. If you're reading this, you're already here.
+
+Run the commands `nvm use` and then `npm install --force`.
+
+That's it! The app is now ready to launch.
+
+### Running
+
+To start the app, simply run the command `npm start`.
+
+## Conclusion
+
+This is a simple and not very attractive app, but it does what it should: show you how to work with the Cardano Serialization Lib.

example/craco.config.js

@@ -0,0 +1,22 @@
+module.exports = {
+  webpack: {
+    configure: (config) => {
+      const wasmExtensionRegExp = /\.wasm$/
+      config.resolve.extensions.push('.wasm')
+      config.experiments = {
+        ...config.experiments,
+        asyncWebAssembly: true,
+      }
+
+      config.module.rules.forEach((rule) => {
+        ;(rule.oneOf || []).forEach((oneOf) => {
+          if (oneOf.type === 'asset/resource') {
+            oneOf.exclude.push(wasmExtensionRegExp)
+          }
+        })
+      })
+
+      return config
+    },
+  },
+}