![](\"docs/logo.png\"){kind=logo}
š
\n\n---\n\n## Overview \n\nContains code to handle business logic of organizations that containn groups of users. Includes but not limited to the following functions:\n - create/update/delete organizations\n - adding and managing users to organizations\n - managing the roles of users on organizations\n - upload attachments and images to organizations\n - creating and approving change requests to data on an organization\n\n\n## š Project Structure \n```\n.\nāāā .github \nāāā .husky # husky settings - @basaldev/lint-staged-config\nāāā .vscode # vscode settings\nāāā .yarn # yarn binary, config and project dependencies\nāāā coverage * # jest coverage report\nāāā dist *\nāāā docs\nā āāā assets # documentation related assets\nā āāā reference # api docs\nāāā src\nā āāā adapter\nā āāā test\nā āāā index.ts\nāāā .eslintignore\nāāā .eslintrc.js # @basaldev/eslint-config\nāāā .gitignore\nāāā .nvmrc\nāāā .pnp.cjs # yarn config\nāāā .pnp.loader.mjs # yarn config\nāāā .prettierignore\nāāā .prettierrc.json # @basaldev/prettier-config\nāāā .yarnrc.yml # yarn config\nāāā cspell.config.js # @basaldev/cspell-config\nāāā .yarnrc.yml # yarn config\nāāā jest.config.js # @basaldev/jest-preset\nāāā package.json\nāāā README.md\nāāā tsconfig.json # @basaldev/tsconfig\nāāā yarn.lock\n\n* Not tracked by git\n```\n\n## š° Setup\n\n**Get NPMJS private token for nodeblocks**\n\n1. Please contact @basal-gen or @basal-luke for getting the token\n2. Add to your local environment - `.zshrc` `.bashrc` etc\n\n```sh\nexport NODEBLOCKS_DEV_TOKEN=__INSERT_YOUR_TOKEN_HERE__\n```\n\n**Install NVM** \n\n- [OSX / Linux](https://github.com/nvm-sh/nvm#installing-and-updating)\n- [Windows](https://github.com/coreybutler/nvm-windows)\n\n**Install Yarn (Global)**\n\n[Yarn](https://yarnpkg.com/) must be installed globally for the __project's NodeJS version__. This should be done so using the command below.\n\n```sh\nnvm use && npm install -g yarn\n```\n**Install Husky šŗ**\n```\nyarn husky install\n```\n**ā ļø IMPORTANT: Only use the `yarn` command install or run scripts. Do not use `npm run xxx`**\n\n## šŖ Usage\n\n**Run typescript compiler**\n\n```sh\nyarn start\n```\n\n**Run debug server on default port:** `9339`.\n- Requires `yarn start` to be running in a separate session\n- Port should be updated to avoid conflicts with other projects `package.json > scripts > debug`\n\n```sh\nyarn debug\n```\n\n**Run unit tests**\n```sh\ndocker compose up\nyarn test\n```\n\n**Installing packages**\n```sh\nyarn add