refactor: new structure

.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: Publish on NPM
+
+on:
+  push:
+    tags:
+      - 'js-v*.*.*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+        with:
+          version: latest
+
+      - uses: actions/setup-node@v4
+        with:
+          cache: 'pnpm'
+          node-version: 20
+          registry-url: 'https://registry.npmjs.com'
+          cache-dependency-path: 'pnpm-lock.yaml'
+
+      - name: Publish package
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          pnpm install && pnpm build
+          npm publish --provenance --access public

.gitignore

@@ -1,2 +1,2 @@
-node_modules
-dist
+node_modules/
+dist/

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint"
+  ]
+}

.vscode/settings.json

@@ -1,13 +1,11 @@
 {
-  "cSpell.language": "en,fr",
-
-  "editor.insertSpaces": true,
   "editor.detectIndentation": false,
+  "editor.insertSpaces": true,
   "editor.tabSize": 2,
 
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": "explicit"
   },
 
-  "eslint.experimental.useFlatConfig": true
+  "eslint.useFlatConfig": true
 }

CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing
+
+## Development
+
+To start developing, clone the repository and install the dependencies.
+
+```bash
+# Clone the repository.
+git clone https://github.com/LiterateInk/PawRD && cd PawRD
+# Switch to the JS/TS implementation branch.
+git checkout js
+# Install dependencies.
+pnpm install
+```
+
+> In case you don't have `pnpm` installed, you can install it by running `npm install --global pnpm`.
+
+## Release
+
+Currently using `release-it` to create a tag and GitHub release.
+
+```bash
+# Create a new release.
+pnpm release
+```
+
+An action will automatically publish the package to NPM when a tag is pushed to the repository.