LoopBack connector for ArangoDB
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
data
src
test
.gitignore
.jshintrc
.npmignore
.npmrc
.travis.yml
CHANGES.md
LICENSE
README.md
index.js
package.json

README.md

loopback-connector-arangodb

tag build Coverage Status license:mit
npm npm downloads dependencies devDependency

The ArangoDB connector for the LoopBack framework.

Note

  1. Version 2.x.x drop support for node v0.12. The supported version are node v4.x.x and v6.x.x
  2. If you want to migrate to 2.x.x and use ArangoDB 2.8.x is it necessary to configure the connector to use the old version. Example:
    "test": {
        "arangodb": {
            "host": "127.0.0.1",
            "database": "test",
            "username": "youruser",
            "password": "yourpass",
            "port": 8529,
            "arangoVersion": 28000
        }
    }

Customizing ArangoDB configuration for tests/examples

By default, examples and tests from this module assume there is a ArangoDB server instance running on localhost at port 8529.

To customize the settings, you can drop in a .loopbackrc file to the root directory of the project or the home folder.

Note: Tests and examples in this project configure the data source using the deprecated '.loopbackrc' file method, which is not suppored in general. For information on configuring the connector in a LoopBack application, please refer to LoopBack documentation.

The .loopbackrc file is in JSON format, for example:

    {
        "dev": {
            "arangodb": {
                "host": "127.0.0.1",
                "database": "test",
                "username": "youruser",
                "password": "yourpass",
                "port": 8529
            }
        },
        "test": {
            "arangodb": {
                "host": "127.0.0.1",
                "database": "test",
                "username": "youruser",
                "password": "yourpass",
                "port": 8529
            }
        }
    }

Note: username/password is only required if the ArangoDB server has authentication enabled.

Contributing

We love contributions!

When contributing, follow the simple rules:

  • Don't violate DRY principles.
  • Boy Scout Rule needs to have been applied.
  • Your code should look like all the other code – this project should look like it was written by one man, always.
  • If you want to propose something – just create an issue and describe your question with as much description as you can.
  • If you think you have some general improvement, consider creating a pull request with it.
  • If you add new code, it should be covered by tests. No tests – no code.
  • If you add a new feature, don't forget to update the documentation for it.
  • If you find a bug (or at least you think it is a bug), create an issue with the library version and test case that we can run and see what are you talking about, or at least full steps by which we can reproduce it.

Running tests

The tests in this repository are mainly integration tests, meaning you will need to run them using our preconfigured test server.

  1. Ask a core developer for instructions on how to set up test server credentials on your machine
  2. npm test

Release notes

License

MIT