Skip to content

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Chen Hui Jing committed Feb 7, 2019
0 parents commit ed4a198
Show file tree
Hide file tree
Showing 9 changed files with 1,171 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .example-env
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Environment Config

# store your secrets and config variables in here
# only invited collaborators will be able to see your .env values

# reference these in your code with process.env.SECRET

NEXMO_API_KEY=''
NEXMO_API_SECRET=''
PORT=

# note: .env is a shell file so there can't be spaces around =
12 changes: 12 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Dependency directories
node_modules/

# dotenv environment variables file
.env
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Getting started with Nexmo's Number Insight APIs on Koa.js

[![Remix on Glitch](https://cdn.glitch.com/2703baf2-b643-4da7-ab91-7ee2a2d00b5b%2Fremix-button.svg)](https://glitch.com/edit/#!/remix/number-insight-koa)

This project introduces the [Nexmo Number Insight API](https://developer.nexmo.com/number-insight/overview) and how to retrieve information about a number via a web interface using [Koa.js](https://koajs.com/).

To set up your own version, run the following commands after cloning the repo, or [remix the Glitch version](https://glitch.com/edit/#!/nexmo-number-insight-dashboard):

```bash
$ npm install
$ cp .example-env > .env # Remember to include your own API keys
$ node server.js
```
Remember to enter your Nexmo API credentials in your `.env` file.
Loading

0 comments on commit ed4a198

Please sign in to comment.