Skip to content

bigconnect/bigconnect-explorer

Repository files navigation

BigConnect Logo
The multi-model Big Graph Store

Welcome to BigConnect Explorer !

bigconnect.io

The visual face of BigConnect.

Features:

  • Dashboard with configurable widgets
  • Collaboration using spaces
  • Global faceted search with aggregation support
  • Graph visualization with advanced features
  • Charts
  • Map visualization
  • Timeline visualization
  • Custom item viewer for documents, video, audio & images
  • Annotation of text & images
  • Data Schema configuration
  • Extensible at all levels with plugins
  • LDAP & SSO integration
  • Developed in Java, React & FlightJS

Have a look at the Overview of BigConnect Explorer to get a glimpse of the features available.

Installation

BigConnect can be run just about anywhere using the deployment methods described below.

After starting BigConnect Explorer, have a look at the Tutorial to understand its features.

Docker

To run the latest build via Docker with the RocksDB backend and embedded ElasticSearch, just type

docker run -d -p 8888:8888 -p 10242:10242 bigconnect/bigconnect-explorer

If you would like to persist data between runs you can supply a volume to the docker run command:

docker run -d -p 10242:10242 -p 8888:8888 -v /tmp/datastore:/bc/datastore bigconnect/bigconnect-explorer

Now, open a browser and go to http://localhost:8888/

Login with the following details:

  • Username: admin
  • Password admin

Locally

To run the latest build you need to build the project first. You need to have Maven installed and JDK11.

mvn -Pbin-release clean install

The release artifacts are available in the release/target/explorer-* folder

Development

  1. Use IntelliJ IDEA to import the project form existing sources (maven). Choose the project folder.

  2. Create a run configuration of type Application with the following parameters:

    • Name: BC Tomcat
    • Main Class: com.mware.web.TomcatWebServer
    • VM Arguments: -DHADOOP_HOME=/opt/bdl/lib/hadoop
    • Program arguments: --webAppDir $MODULE_DIR$/../war/src/main/webapp --port 8888
    • Working directory: $MODULE_DIR$/..
    • Environment variables: BIGCONNECT_DIR=$MODULE_DIR$/..
    • Use classpath of module: bc-tomcat-server
    • FOR JDK 11: VM arguments: --add-opens java.base/java.lang=ALL-UNNAMED
  3. Start the "BC Tomcat" run configuration

JavaScript Development instructions

  1. Run npm install in war/src/main/webapp

  2. If changes are made to the package.json file you need to run mvn compile from the project/web/war folder

  3. To compile all JavaScript and Less files run grunt from the project/web/war/src/main/webapp folder

  4. After all files are compiled, you can start the watch.cmd utility from the project/web/war/src/main/webapp folder to scan for filesystem changes

    Note: While the watch utility is running, any change to less, hbs, ejs, js and jsx files will be automatically compiled. To see your changes, just refresh the browser window. This process can be run while the application is running.

  5. Do NOT commit files from the css and jsc folders. These folders are generated by the grunt compilation tasks.

Contributing

Contributions are warmly welcomed and greatly appreciated. Here are a few ways you can contribute:

  • Start by fixing some issues
  • Submit a Pull Request with your fix

Getting help & Contact

License

BigConnect is an open source product licensed under AGPLv3.

About

The visual face of BigConnect

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •