Giter VIP home page Giter VIP logo

ccdi-portal-webservice's Introduction

Codacy Badge

Bento Backend Framework Configuration Guide

This is the user documentation for the Bento Backend.

Introduction

The Bento Backend Framework is a server-side backend written in Java to be used with Bento based applications. The Bento Backend is meant to be used in conjunction with the Bento Frontend Framework and a Neo4j database running the GraphQL plugin.

The Bento Backend can be found in this Github Repository: Bento Backend

Pre-requisites

  • Java 11 or newer installed on the server hosting the Bento Backend
  • The Neo4j database containing the Bento data has been initialized and is running

Configuration

The following file will need to be edited to configure the Bento Backend Code to work within a Bento based application:

src/main/resources/application.properties

  1. create this file by creating a copy of src/main/resources/application_example.properties and renaming it to use as a starting point.
  2. Line 2 - change the value of neo4j.graphql.endpoint to the GraphQL endpoint running on the applications Neo4j database.
  3. Line 4 - change the value of graphql.schema to the path of the GraphQL schema file that will be uploaded to the database. The file path should be relative to the main folder in the project.
  4. Line 5 - change the value of neo4j.authorization to the basic access authentication for your Neo4j database. (See the Basic Access Authentication section for instructions on how to generate this value).
  5. Line 9 - this value is an all lowercase Boolean value to determine if GraphQL queries will be enabled for the application.
  6. Line 10 - this value is an all lowercase Boolean value to determine if GraphQL mutations will be enabled for the application.

Basic Access Authentication

The basic access authentication value used in the application.properties file is of the form Basic <base64 encoding of username:password>. To generate this value generate the base64 encoding of the username and password as shown below and append that to the String “Basic “. a

Example

  • Username:neo4j
  • Password:my_password
  • Authorization Value:Basic bmVvNGo6bXlfcGFzc3dvcmQ=

Generate base64 encoding in terminal/bash

echo -n "neo4j:my_password" | base64

Generate base64 encoding in powershell

[Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes("neo4j:my_password"))

ccdi-portal-webservice's People

Contributors

david-yuwei avatar austinsmueller avatar knockknockyoo avatar n2iw avatar jw34 avatar michael-fleming avatar shawnwangnih avatar alexd-conf avatar

Stargazers

Nick Fn Blum avatar

Watchers

Mark Jensen avatar Lawrence Brem avatar  avatar  avatar  avatar Sue Pan avatar  avatar Amit Mukherjee avatar Karan Sheth avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.