Giter VIP home page Giter VIP logo

koa-neo4j-starter-kit's Introduction

koa-neo4j-starter-kit

A blueprint for creating RESTful web servers with koa-neo4j

Install

Assuming Node version >= 4 and NPM are installed:

git clone https://github.com/assister-ai/koa-neo4j-starter-kit.git
cd koa-neo4j-starter-kit
npm install

Usage

To run the server, you need a running Neo4j instance. Set your Neo4j config (boltUrl and password) in src/settings.js

For development:

npm start

For production, you need to set environment variables referred by src/settings.js (either in your shell or ideally in a docker-compose conf), then simply:

npm run serve

Best practices

  • Put all your configuration objects in src/settings.js and configure your development environment
  • Keep related logic be .js or .cyp in the same directory (src/user, src/articles and src/noncypher directories are examples).
  • Import the logic that you want to be included in the bundle at src/server.js

License

MIT

koa-neo4j-starter-kit's People

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

koa-neo4j-starter-kit's Issues

space in route

Hi!

First, great module, works very well.

I've run into one thing and I've tried a number of things but can't seem to get through it. I'm doing a query on a user name in neo4j and the name contains a space. This gets turned into %20 in the url but it doesn't seem to get turned back to a space.

I just want to validate that this is as expected, the route does not parse out the % values to actual characters to pass into the cypher query. If that's the case, any suggestions as I don't want to recreate the data set to remove all spaces in all properties.

Thanks!

TypeError: Cannot read property 'parse' of undefined

Following the install and usage instructions in the readme.

After npm start I get the following error:

App listening on port 3000.
Error connecting to the Neo4j instance, check connection options
TypeError: Cannot read property 'parse' of undefined
    at /home/jrs1/neo4j/playing/koa-neo4j-starter-kit/node_modules/koa-neo4j/index.js:2722:72
    at process._tickCallback (internal/process/next_tick.js:103:7)
(node:18618) UnhandledPromiseRejectionWarning: Unhandled promise rejection (rejection id: 1): TypeError: Cannot read property 'parse' of undefined
(node:18618) DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

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.