{"id":20374370,"url":"https://github.com/arcadedata/arcadeanalytics","last_synced_at":"2025-08-20T08:33:37.434Z","repository":{"id":34266195,"uuid":"170344881","full_name":"ArcadeData/arcadeanalytics","owner":"ArcadeData","description":"Arcade Analytics is the first Open Source Graph Analytics platform. Connect your Graph Database (Neo4j, OrientDB, Amazon Neptune, Microsoft CosmosDB, etc) and RDBMS (Oracle, MySQL, Postgres, Microsoft SQLServer, MariaDB) to create powerful dashboards.","archived":false,"fork":false,"pushed_at":"2023-01-09T05:00:48.000Z","size":15200,"stargazers_count":190,"open_issues_count":59,"forks_count":30,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-12-09T12:12:21.833Z","etag":null,"topics":["analytics","charts","dashboards","graph-analytics","graphdb","widgets"],"latest_commit_sha":null,"homepage":"https://arcadeanalytics.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ArcadeData.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["arcadedata"]}},"created_at":"2019-02-12T15:47:27.000Z","updated_at":"2024-09-16T19:11:41.000Z","dependencies_parsed_at":"2023-01-15T06:00:36.806Z","dependency_job_id":null,"html_url":"https://github.com/ArcadeData/arcadeanalytics","commit_stats":null,"previous_names":["arcadeanalytics/arcadeanalytics"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArcadeData%2Farcadeanalytics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArcadeData%2Farcadeanalytics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArcadeData%2Farcadeanalytics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArcadeData%2Farcadeanalytics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ArcadeData","download_url":"https://codeload.github.com/ArcadeData/arcadeanalytics/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230408171,"owners_count":18220974,"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":["analytics","charts","dashboards","graph-analytics","graphdb","widgets"],"created_at":"2024-11-15T01:24:02.416Z","updated_at":"2024-12-19T09:08:13.061Z","avatar_url":"https://github.com/ArcadeData.png","language":"JavaScript","readme":"[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![Build Status](https://travis-ci.org/ArcadeAnalytics/arcadeanalytics.svg?branch=master)](https://travis-ci.org/ArcadeAnalytics/arcadeanalytics)\n\n![Arcade Analytics Screenshot](https://arcadeanalytics.com/wp-content/uploads/2018/11/arcade-panama-papers-dashboard.png)\n\n# If you want to just run\n\nGo to https://github.com/ArcadeData/arcadeanalytics-recipes\n\nclone that repo and run\n\ndocker-compose -f recipes/arcade-standalone.yml up\n\n# Arcade Analytics - Play With Data\n\nDocker images of Arcade and demo databases are available on [Docker hub](https://cloud.docker.com/u/arcadeanalytics/)\n\n## Quick start \n\nTo launch ArcadeAnalytics just run (needs docker installed)\n\n    docker-compose -f src/main/docker/app.yml up\n    \nand then go to \n    \n    http://localhost:8080/\n    \nlogin as _user_ with password _user_\n\nTo be able to create new users, fill the properties inside the compose:\n\n          - SPRING_EMAIL_HOST=smtp.gmail.com\n          - SPRING_EMAIL_PORT=587\n          - SPRING_EMAIL_USERNAME=\n          - SPRING_EMAIL_PASSWORD=\n          - JHIPSTER_MAIL_FROM=\n          - JHIPSTER_MAIL_BASE-URL=\n\nThen restart the container and login with _admin/admin_ credentials.\n\nThe Docker compose starts ArcadeAnalytics, a PostgreSQL database, an Elastic instance and an OrientDB with its _demodb_ preloaded.\n\nFor detailed instructions on how to use Arcade read the [manual](https://arcadeanalytics.com/usermanual/) \n\n## Start with \"single\" (embedded) image\n\nArcade is provided as a all-embedded image, where hsql and embedded Elasicsearch are used instead of Postgresql and ES on separate containers.\n\n    docker-compose -f src/main/docker/app-single.yml up\n\nThis compose does not start containers with test databases.\n\n## Configure SSH \n\nAracadeAnalytics can connect to databases using an SSH tunnel.\nTo do that, it needs the private and public keys to be used by the application.\nIn the _app.yml_ or _app-single.yml_ :\n\n              - JAVA_OPTS=-DSSH_PRIV_KEY=/arcade/.ssh/id_rsa -DSSH_PUB_KEY=/arcade/.ssh/id_rsa.pub\n\nThe directory /arcade inside the container is mounted as volume:\n\n            volumes:\n              - ~/.arcade/:/arcade/\n\nCreate a directory in *~/.arcade/* named *.ssh* and put the private and public keys inside.\nThe public key should be copied on the server used as ssh gateway too.\n\n\n## Run support containers with test databases\n\nCheck the [dedicated repository](https://github.com/ArcadeAnalytics/arcadeanalytics-recipes)\n\n## Connect to Amazon AWS\n\nRead the dedicated [post](https://arcadeanalytics.com/amazon-neptune-hands-on/).\nUse your own SSH keys, as explained in the previous paragraph.\n\n## Development\n\n*NOTE*: Arcade was built using JHipster\n\nBefore you can build this project, you must install and configure the following dependencies on your machine:\n\n1. [Node.js][]: We use Node to run a development web server and build the project.\n   Depending on your system, you can install Node either from source or as a pre-packaged bundle.\n2. [Yarn][]: We use Yarn to manage Node dependencies.\n   Depending on your system, you can install Yarn either from source or as a pre-packaged bundle.\n\nAfter installing Node, you should be able to run the following command to install development tools.\nYou will only need to run this command when dependencies change in [package.json](package.json).\n\n    yarn install\n\nWe use yarn scripts and [Webpack][] as our build system.\n\n\nRun the following commands in two separate terminals to create a blissful development experience where your browser\nauto-refreshes when files change on your hard drive.\n\n    ./mvnw\n    yarn start\n\n[Yarn][] is also used to manage CSS and JavaScript dependencies used in this application. You can upgrade dependencies by\nspecifying a newer version in [package.json](package.json). You can also run `yarn update` and `yarn install` to manage dependencies.\nAdd the `help` flag on any command to see how you can use it. For example, `yarn help update`.\n\nThe `yarn run` command will list all of the scripts available to run for this project.\n\n### Service workers\n\nService workers are commented by default, to enable them please uncomment the following code.\n\n* The service worker registering script in index.html\n```\n\u003cscript\u003e\n    if ('serviceWorker' in navigator) {\n        navigator.serviceWorker\n        .register('./sw.js')\n        .then(function() { console.log('Service Worker Registered'); });\n    }\n\u003c/script\u003e\n```\n* The copy-file option in webpack-common.js\n```js\n{ from: './src/main/webapp/sw.js', to: 'sw.js' },\n```\nNote: Add the respective scripts/assets in `sw.js` that is needed to be cached.\n\n### Managing dependencies\n\nFor example, to add [Leaflet][] library as a runtime dependency of your application, you would run following command:\n\n    yarn add --exact leaflet\n\nTo benefit from TypeScript type definitions from [DefinitelyTyped][] repository in development, you would run following command:\n\n    yarn add --dev --exact @types/leaflet\n\nThen you would import the JS and CSS files specified in library's installation instructions so that [Webpack][] knows about them:\nEdit [src/main/webapp/app/vendor.ts](src/main/webapp/app/vendor.ts) file:\n~~~\nimport 'leaflet/dist/leaflet.js';\n~~~\n\nEdit [src/main/webapp/content/css/vendor.css](src/main/webapp/content/css/vendor.css) file:\n~~~\n@import '~leaflet/dist/leaflet.css';\n~~~\nNote: there are still few other things remaining to do for Leaflet that we won't detail here.\n\nFor further instructions on how to develop with JHipster, have a look at [Using JHipster in development][].\n\n### Using angular-cli\n\nYou can also use [Angular CLI][] to generate some custom client code.\n\nFor example, the following command:\n\n    ng generate component my-component\n\nwill generate few files:\n\n    create src/main/webapp/app/my-component/my-component.component.html\n    create src/main/webapp/app/my-component/my-component.component.ts\n    update src/main/webapp/app/app.module.ts\n\n### Doing API-First development using swagger-codegen\n\n[Swagger-Codegen]() is configured for this application. You can generate API code from the `src/main/resources/swagger/api.yml` definition file by running:\nThen implements the generated interfaces with `@RestController` classes.\n\nTo edit the `api.yml` definition file, you can use a tool such as [Swagger-Editor](). Start a local instance of the swagger-editor using docker by running: `docker-compose -f src/main/docker/swagger-editor.yml up -d`. The editor will then be reachable at [http://localhost:7742](http://localhost:7742).\n\nRefer to [Doing API-First development][] for more details.\n\n## Building for production\n\nTo optimize the arcadeanalytics application for production, run:\n\n    ./mvnw -Pprod clean package\n\nThis will concatenate and minify the client CSS and JavaScript files. It will also modify `index.html` so it references these new files.\nTo ensure everything worked, run:\n\n    java -jar build/libs/*.war\n\nThen navigate to [http://localhost:8080](http://localhost:8080) in your browser.\n\nRefer to [Using JHipster in production][] for more details.\n\n## Testing\n\nTo launch your application's tests, run:\n\n    ./mvnvtest\n\n### Client tests\n\nUnit tests are run by [Karma][] and written with [Jasmine][]. They're located in [src/test/javascript/](src/test/javascript/) and can be run with:\n\n    yarn test\n\nUI end-to-end tests are powered by [Protractor][], which is built on top of WebDriverJS. They're located in [src/test/javascript/e2e](src/test/javascript/e2e)\nand can be run by starting Spring Boot in one terminal (`./gradlew bootRun`) and running the tests (`yarn run e2e`) in a second one.\n\n### Other tests\n\nPerformance tests are run by [Gatling][] and written in Scala. They're located in [src/test/gatling](src/test/gatling) and can be run with:\n\n    ./mvnw gatling:test\n\nFor more information, refer to the [Running tests page][].\n\n## Using Docker to simplify development (optional)\n\nYou can use Docker to improve your JHipster development experience. A number of docker-compose configuration are available in the [src/main/docker](src/main/docker) folder to launch required third party services.\nFor example, to start a postgresql database in a docker container, run:\n\n    docker-compose -f src/main/docker/postgresql.yml up -d\n\nTo stop it and remove the container, run:\n\n    docker-compose -f src/main/docker/postgresql.yml down\n\nYou can also fully dockerize your application and all the services that it depends on.\nTo achieve this, first build a docker image of your app by running:\n\n    ./mvnw clean package -Pprod \n\nThen run:\n\n    docker-compose -f src/main/docker/app.yml up -d\n\nFor more information refer to [Using Docker and Docker-Compose][], this page also contains information on the docker-compose sub-generator (`jhipster docker-compose`), which is able to generate docker configurations for one or several JHipster applications.\n\n## Continuous Integration (optional)\n\nTo configure CI for your project, run the ci-cd sub-generator (`jhipster ci-cd`), this will let you generate configuration files for a number of Continuous Integration systems. Consult the [Setting up Continuous Integration][] page for more information.\n\n[JHipster Homepage and latest documentation]: http://www.jhipster.tech\n[JHipster 4.11.1 archive]: http://www.jhipster.tech/documentation-archive/v4.11.1\n\n[Using JHipster in development]: http://www.jhipster.tech/documentation-archive/v4.11.1/development/\n[Using Docker and Docker-Compose]: http://www.jhipster.tech/documentation-archive/v4.11.1/docker-compose\n[Using JHipster in production]: http://www.jhipster.tech/documentation-archive/v4.11.1/production/\n[Running tests page]: http://www.jhipster.tech/documentation-archive/v4.11.1/running-tests/\n[Setting up Continuous Integration]: http://www.jhipster.tech/documentation-archive/v4.11.1/setting-up-ci/\n\n[Gatling]: http://gatling.io/\n[Node.js]: https://nodejs.org/\n[Yarn]: https://yarnpkg.org/\n[Webpack]: https://webpack.github.io/\n[Angular CLI]: https://cli.angular.io/\n[BrowserSync]: http://www.browsersync.io/\n[Karma]: http://karma-runner.github.io/\n[Jasmine]: http://jasmine.github.io/2.0/introduction.html\n[Protractor]: https://angular.github.io/protractor/\n[Leaflet]: http://leafletjs.com/\n[DefinitelyTyped]: http://definitelytyped.org/\n[Swagger-Codegen]: https://github.com/swagger-api/swagger-codegen\n[Swagger-Editor]: http://editor.swagger.io\n[Doing API-First development]: http://www.jhipster.tech/documentation-archive/v4.11.1/doing-api-first-development/\n","funding_links":["https://github.com/sponsors/arcadedata"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farcadedata%2Farcadeanalytics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farcadedata%2Farcadeanalytics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farcadedata%2Farcadeanalytics/lists"}