Nexmo Client SDK Express Server

by nexmo-community

GitHub Readme.md

Nexmo

Build Your Own Contact Center (Node.js server)

This is one of the components required for Nexmo's "Contact Center Use Case".

To get started, you can use this server as a basis for your application's backend. You can run it locally or deploy it to Heroku as described below.

Table of Contents

Getting Started

Start Locally

Nexmo Account

To be able to use this application you'll need to Sign up for a Nexmo account.

Mongo Database

Set up a database and make note of the service address. It usually starts with mongodb:// on port 27017. You'll need to add this to the environment file.

Environment File

Create an environment file by copying the example file, .example.env to .env, and editing it with your own configuration. Omitting environment variables will cause the application to use default values. As Nexmo needs to be able to access the server to provide NCCOs, default values will prevent you from making calls.

APP_URL=http://url-for-the-server.com
PORT=4000
MOBILE_API_KEY=a-random-url-key-here
MONGO_URL=mongodb://localaddress:27017/database-name

Start it!

Before you start it for the first time, run this to install our dependencies.

npm install

Once installed, you can now run it locally.

npm run dev

Deploy with Heroku

This application is configured to deploy to Heroku.

Deploy

Code of Conduct

In the interest of fostering an open and welcoming environment, we strive to make participation in our project and our community a harassment-free experience for everyone. Please check out our Code of Conduct in full.

Contributing

We ❤️ contributions from everyone! Check out the Contributing Guidelines for more information.

contributions welcome

License

This project is subject to the MIT License