A Node.js server providing authentication, management and messaging
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.
__mocks__
api
locales
logs
seeds/test
src
templates
tools
.dockerignore
.gitignore
.gitlab-ci.yml
.npmrc
CONTRIBUTING.md
Dockerfile
LICENSE
README.md
REGISTRY
package-lock.json
package.json
tsconfig.json
tslint.yaml

README.md

Iris Api Server

Environment Variables

Name Description
NODE_ENV What environment the system is running in.
MONGO_URI Where the mongo database is and how to connect to it, more info
JWT_SECRET The secret for json web tokens, more info
API_URL The public url of this api, e.g. https://api.irismsg.io
WEB_URL The public url of the web, e.g. https://web.irismsg.io (not currently used)
SHRINK_URL optional – The public url of the url shrinker if you want sms links to be shrank, points to a shrinky-link instance, e.g. http://shrinky:3000
SHRINK_KEY Your key for shrinky-link, used to generate short links
TWILIO_TOKEN Your twilio access token, more info
TWILIO_SID Your twilio sid
TWILIO_NUMBER Your twilio number, the number service sms will be sent from
TWILIO_FALLBACK If the sms donation algorithm should fall back to using twilio
FIREBASE_DB Where your firebase database is
PLAY_STORE_URL The link to download the irismsg app

Mounted Files

File Description
/app/assetlinks.json Your android asset links file, more info
/app/google-account.json Your Firebase account file, more info

Dev Notes

# Run a mongo (in one terminal window)
npm run mongo

# Run the docker image once (in a different window)
docker run -it --rm \
  -p 3000:3000 \
  --link iris_mongo \
  --env-file .env \
  -e MONGO_URI=mongodb://iris_mongo/iris \
  -v `pwd`/google-account.json:/app/google-account.json \
  openlab.ncl.ac.uk:4567/iris/api