Use relative url instead of static urls

[popojargo]

Overview

• Add helper functions to get API url and Server urls
• Fix some url who were not using relative urls
• Fix documentation urls that were using _utils instead of relative
• Update test according to change
• Changed default configuration in settings.json

Testing recommendations

I used a express pouchdb setup.

1. Create a folder 👍
2. In that folder create a package.json

{
  "name": "test",
  "version": "1.0.0",
  "description": "",
  "main": "test.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "dependencies": {
    "express": "^4.16.3",
    "express-pouchdb": "^4.0.0",
    "morgan": "^1.4.0",
    "pouchdb": "^6.4.3"
  }
}

3. Create a test.js

var express = require('express')
    , app = express()
    , PouchDB = require('pouchdb')
    , logger = require('morgan')
;

app.use(logger("tiny"));
app.get('/', function (req, res, next) {
    res.send('Welcome Traveler!  <a href="/db/_utils/">Fauxton?</a>');
});
//app.use('/express-pouchdb', require('express-pouchdb')(PouchDB));
app.use('/db', require('express-pouchdb')(PouchDB));
app.listen(3000);

4. Install depencies with npm install

5. You need to edit node_modules/express-pouchdb/lib/routes/fauxton.js and change the exports for:

module.exports = function (app) {
  app.get('/_utils/', function (req, res) {
    // We want to force /_utils to /_utils/ as this is the CouchDB behavior
    // https://git.io/vDMOD#L78
    // https://git.io/vDMOQ#L974
    if (req.originalUrl === '/_utils') {
      res.redirect(301, '/_utils/');
    } else {
      res.sendFile(path.normalize(FAUXTON_PATH + '/index.html'));
    }
  });

  app.use('/_utils/', express.static(FAUXTON_PATH));
};

6. Make a fauxton release (grunt release) and copy the release to node_modules/pouchdb-fauxton/www

7. You need to replace in the index.html of the release (dashboard -> ./dashboard)

8. You should be good 💃

GitHub issue number

#944

Checklist

• Code is written and works correctly;
• Changes are covered by tests;
• Documentation reflects the changes;
• Update rebar.config.script with the correct tag once a new Fauxton release is made

[popojargo]

I should probably use the getServerUrl here to be more consistent but I had trouble with circular dependencies 😞

[popojargo]

I remove the first slash to avoid having //_session

[popojargo]

In dev, we have a proxy at the root

[popojargo]

In a release, Fauxton should be at /_utils/ so we have to get back one "folder".

[wohali]

+1 on this if you can rebase it

[Antonio-Maranhao]

+1

[popojargo]

I will compile Couch with this branch and see if there's not breaking change. Then I'll merge when Travis goes green