Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nexmo-community/contact-center-server-node
Build Your Own Contact Center (Node.js server). This is one of the components required for Nexmo's "Contact Center Use Case". You can run it locally or deploy it to Heroku as described below.
https://github.com/nexmo-community/contact-center-server-node
client-sdk contact-center database heroku nexmo nexmo-account server
Last synced: 21 days ago
JSON representation
Build Your Own Contact Center (Node.js server). This is one of the components required for Nexmo's "Contact Center Use Case". You can run it locally or deploy it to Heroku as described below.
- Host: GitHub
- URL: https://github.com/nexmo-community/contact-center-server-node
- Owner: nexmo-community
- License: mit
- Created: 2019-04-26T15:26:55.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T18:17:35.000Z (9 months ago)
- Last Synced: 2024-05-02T01:00:40.365Z (8 months ago)
- Topics: client-sdk, contact-center, database, heroku, nexmo, nexmo-account, server
- Language: JavaScript
- Homepage: https://developer.nexmo.com/client-sdk/in-app-voice/contact-center-overview
- Size: 457 KB
- Stars: 3
- Watchers: 12
- Forks: 7
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Build Your Own Contact Center (Node.js server)
This is one of the components required for Nexmo's ["Contact Center Use Case"](https://developer.nexmo.com/client-sdk/in-app-voice/contact-center-overview).
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](#getting-started)
- [Start Locally](#start-locally)
- [Nexmo Account](#nexmo-account)
- [Mongo Database](#mongo-database)
- [Environment File](#environment-file)
- [Start it!](#start-it)
- [Deploy with Heroku](#deploy-with-heroku)
- [Code of Conduct](#code-of-conduct)
- [Contributing](#contributing)
- [License](#license)
## Getting Started
### Start Locally
#### Nexmo Account
To be able to use this application you'll need to [Sign up for a Nexmo account][signup].
#### 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.
```js
npm install
```
Once installed, you can now run it locally.
```js
npm run dev
```
### Deploy with Heroku
This application is configured to deploy to Heroku.
[](https://heroku.com/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][coc] in full.
## Contributing
We :heart: contributions from everyone! Check out the [Contributing Guidelines][contributing] for more information.
[![contributions welcome][contribadge]][issues]
## License
This project is subject to the [MIT License][license]
[logo]: nexmo.png "Nexmo"
[contribadge]: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat "Contributions Welcome"
[signup]: https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=lukeocodes
[coc]: CODE_OF_CONDUCT.md "Code of Conduct"
[contributing]: CONTRIBUTING.md "Contributing"
[license]: LICENSE "MIT License"
[issues]: ./../../issues "Issues"