{"id":19560338,"url":"https://github.com/cybercentrecanada/assemblyline-ui-frontend","last_synced_at":"2025-04-26T23:33:02.445Z","repository":{"id":37078158,"uuid":"276280099","full_name":"CybercentreCanada/assemblyline-ui-frontend","owner":"CybercentreCanada","description":"Frontend for Assemblyline 4","archived":false,"fork":false,"pushed_at":"2025-04-24T13:44:17.000Z","size":21662,"stargazers_count":9,"open_issues_count":3,"forks_count":9,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-24T14:45:24.385Z","etag":null,"topics":["assemblyline","malware-analysis"],"latest_commit_sha":null,"homepage":"https://cybercentrecanada.github.io/assemblyline4_docs/","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CybercentreCanada.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-07-01T04:53:43.000Z","updated_at":"2025-04-10T17:54:13.000Z","dependencies_parsed_at":"2024-01-28T21:31:11.539Z","dependency_job_id":"f2e5f221-dc08-494e-a2bb-95d671e20776","html_url":"https://github.com/CybercentreCanada/assemblyline-ui-frontend","commit_stats":null,"previous_names":[],"tags_count":2164,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CybercentreCanada%2Fassemblyline-ui-frontend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CybercentreCanada%2Fassemblyline-ui-frontend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CybercentreCanada%2Fassemblyline-ui-frontend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CybercentreCanada%2Fassemblyline-ui-frontend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CybercentreCanada","download_url":"https://codeload.github.com/CybercentreCanada/assemblyline-ui-frontend/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251068040,"owners_count":21531475,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["assemblyline","malware-analysis"],"created_at":"2024-11-11T05:07:16.035Z","updated_at":"2025-04-26T23:32:57.435Z","avatar_url":"https://github.com/CybercentreCanada.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Assemblyline UI Frontend\n\nThis repo is dedicated for the new version off Assemblyline 4 UI. It uses React as the framework and Material UI for the visual components.\n\n## Install dev environment pre-requisites\n\n### Install NodeJS (Ubuntu)\n\nFollow these simple command to get NodeJS installed\n\n    curl -sL https://deb.nodesource.com/setup_18.x | sudo -E bash -\n    sudo apt-get install gcc g++ make\n    sudo apt-get install -y nodejs\n\n### Install Yarn (NPM modules manager)\n\n    curl -sL https://dl.yarnpkg.com/debian/pubkey.gpg | gpg --dearmor | sudo tee /usr/share/keyrings/yarnkey.gpg \u003e/dev/null\n    echo \"deb [signed-by=/usr/share/keyrings/yarnkey.gpg] https://dl.yarnpkg.com/debian stable main\" | sudo tee /etc/apt/sources.list.d/yarn.list\n    sudo apt-get update \u0026\u0026 sudo apt-get install yarn\n\n### Install NPM dependencies\n\nGo to your `assemblyline-ui-frontend` directory and type:\n\n    yarn install\n\n### Install docker (Ubuntu)\n\nFollow these simple commands to get Docker running on your machine:\n\n    # Add Docker repository\n    sudo apt-get update\n    sudo apt-get install -y apt-transport-https ca-certificates curl gnupg-agent software-properties-common\n    curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -\n    sudo apt-key fingerprint 0EBFCD88\n    sudo add-apt-repository \"deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable\"\n\n    # Install Docker\n    sudo apt-get install -y docker-ce docker-ce-cli containerd.io\n\n    # Test Docker installation\n    sudo docker run hello-world\n\n### Install docker-compose\n\nInstalling docker-compose is done the same way on all Linux distros. Follow these simple instructions:\n\n    # Install docker-compose\n    sudo curl -L \"https://github.com/docker/compose/releases/download/1.28.5/docker-compose-$(uname -s)-$(uname -m)\" -o /usr/local/bin/docker-compose\n    sudo chmod +x /usr/local/bin/docker-compose\n\n    # Test docker-compose installation\n    docker-compose --version\n\nFor reference, here are the instructions on Docker’s website: \u003chttps://docs.docker.com/compose/install/\u003e\n\n## Configure the dev environment\n\n### Setup Webpack for debugging behing a proxy\n\nCreate a file named `.env.local` at the root of the assemblyline-ui-frontend directory with the following content:\n\n    HOST=0.0.0.0\n    WDS_SOCKET_PORT=443\n    HTTPS=true\n    BROWSER=none\n\n### Setup docker compose environment\n\n#### Setup IP routing\n\nCreate a file in the `docker` directory named `.env`.\n\nThis file should only contain the following where `\u003cYOUR_IP\u003e` is replaced by your dev computer IP.\n\n    EXTERNAL_IP=\u003cYOUR_IP\u003e\n\n#### Setup Assemblyline config file\n\nFrom the `docker` directory, copy the file `config.yml.template` to `config.yml` in the same directory.\n\nChange the `\u003cYOUR_IP\u003e` in the newly created `config.yml`file to the IP of your dev machine.\n\n#### Setup Assemblyline classification engine file\n\nFrom the `docker` directory, copy the file `classification.yml.template` to `classification.yml` in the same directory.\n\nChange the `enforce` value to `true` in the `classification.yml` file to turn on the classification engine.\n\n## Launch the dev environment\n\n### Dependencies\n\nGo to the `docker` directory and run the following command to launch the Assemblyline DB and UI.\n\n    docker-compose up\n\n### Frontend\n\nSimply use the `npm start script` to launch the frontend.\n\n### Once dependencies and frontend started\n\nAccess the dev frontend at the following link: `https://\u003cYOUR_IP\u003e.nip.io`\n\n## Testing\n\nTesting is done through the `jest` framework.\n\nTo run the tests, simply use the `npm test` command. (Development dependencies should already have been installed\npreviously via the `yarn install` command).\n\nNOTE: the test command will only run tests related to changed files based on git.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcybercentrecanada%2Fassemblyline-ui-frontend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcybercentrecanada%2Fassemblyline-ui-frontend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcybercentrecanada%2Fassemblyline-ui-frontend/lists"}