Provides resources for developers using Nexmo API platforms
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add stale.yml Feb 2, 2018
.repos Rename call.decline to call.reject in Client SDK Building Blocks (#1428) Feb 8, 2019
_api Added support for multiple versions of an API Feb 5, 2019
_code Update voice_proxy.js Oct 30, 2018
_documentation Change default value of next_event_wait (#1466) Feb 20, 2019
_examples Remove OAuth authentication (#1460) Feb 19, 2019
_extend Link to GitHub issues (#1471) Feb 20, 2019
_modals/api
_open_api Change default value of next_event_wait (#1466) Feb 20, 2019
_partials Remove links to client sdk generated js docs (#1447) Feb 14, 2019
_tutorials
app
bin
config Add link to schedule data in PHPUK Hackathon challenge section Feb 21, 2019
db Add redirect tracking (#1027) Oct 16, 2018
lib
log Init Feb 6, 2017
public
spec
tmp
vendor/assets
.babelrc Change webpacker dependency to fork. See: https://github.com/rails/we… Sep 25, 2017
.dockerignore Ignore public/packs Oct 5, 2017
.editorconfig
.env.example Update env.example Nov 13, 2017
.eslintrc.js Add ESLint + Change concatenation tool to understand safe characters Oct 23, 2017
.gitignore
.gitmodules Client SDK docs - initial draft (#1210) Jan 24, 2019
.postcssrc.yml
.pre-commit-config.yaml adding pre-commit hooks Jul 19, 2017
.rspec
.rubocop.yml Have Rubocop ignore the _open_api submodules folder Nov 14, 2018
.ruby-version Upgrade ruby version to 2.5.3 Nov 5, 2018
.travis.yml Render OAS pages at build time Dec 22, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Jun 23, 2017
CONTRIBUTING.md Fix CONTRIBUTING.md nested list rendering (#1169) Oct 30, 2018
Dockerfile Upgrade ruby version to 2.5.3 Nov 5, 2018
Gemfile Update Rack dependency (CVE-2018-16471) Feb 14, 2019
Gemfile.lock
Guardfile
LICENSE.md Add CONTRIBUTING and LICENSE files, tidy README Aug 10, 2018
LICENSE.txt Update License Year (#1150) Oct 23, 2018
Procfile
README.md
Rakefile
app.json Prepare project for deployment with Heroku Nov 14, 2018
config.ru
docker-compose.yml
github_deploy_key.enc
package.json
yarn.lock Add babel dependencies Jan 22, 2018

README.md

Nexmo Developer

Build Status MIT licensed

This repository is the code and content for https://developer.nexmo.com, which includes the Nexmo documentation, API reference, SDKs, Tools & Community content. To get a Nexmo account, sign up for free at nexmo.com.

Testing · Running Locally · Admin Dashboard · Troubleshooting · Contributing · License

Testing

We use rspec to test Nexmo Developer.

To run all tests:

bundle exec rspec

To generate code coverage, set the COVERAGE environment variable when running the tests.

COVERAGE=1 bundle exec rspec

This will create a folder named coverage. Open index.html in this folder to view coverage statistics.

Running locally

The project can be run on your laptop, either directly or using Docker. These instructions have been tested for mac.

Setup for running directly on your laptop

Before you start, you need to make sure that you have:

To set up the project, clone this project and configure your settings:

$ git clone git@github.com:Nexmo/nexmo-developer.git
$ cd nexmo-developer
$ cp .env.example .env

Edit the .env file as appropriate for your platform. Then, run the following:

$ bundle install
$ bin/rails db:create db:migrate db:seed
$ bin/yarn install
$ rails s

NB: If a node incompatibility error is received, please use nvm for managing local node versions. Once installed, run nvm use 9 before running bin/yarn install.

You should now be able to see the site on http://localhost:3000/

Setting up with Docker

If you don't want to install Ruby & PostgreSQL then you can use docker to sandbox Nexmo Developer into its own containers. After you Install Docker run the following:

$ git clone git@github.com:Nexmo/nexmo-developer.git
$ cd nexmo-developer
$ cp .env.example .env

Edit the .env file as appropriate for your platform. Then, start the web server with this command:

$ docker-compose up

At this point, open your browser to http://localhost:3000/ ... and wait (it takes about 30 seconds for the first load).

To stop the server cleanly run:

$ docker-compose down

Admin dashboard

You can access the admin dashboard by visiting /admin. If you've populated data via rake db:seed you will have an admin user with the username of admin@nexmo.com and password of development.

The following is an example if you are running Nexmo Developer within a Docker container:

docker exec -it <container_id> rake db:seed

New admin users can be created by visiting /admin/users or by accessing the rails console and creating a new User like so:

User.create!(email: 'example@example.com', password: 'password', admin: true)

Working with submodules

Some of the contents of NDP are brought in via git submodules, such as the Open API Specification (OAS) documents. A submodule is a separate repository used within the main repository (in this case NDP) as a dependency. The main repository holds information about the location of the remote repository and which commit to reference. So to make a change within a submodule, you need to commit to the submodule and the main repository and crucially remember to push both sets of changes to GitHub.

Here are some tips for working with submodules:

When cloning the repo or starting to work with submodules

git submodule init
git submodule update

When pulling in changes to a branch e.g. updating master

git pull
git submodule update

When making changes inside the submodule within NDP

Make sure you are inside the directory that is a submodule.

  • make your changes
  • commit your changes
  • push your changes from here (this is the bit that normally trips us up)
  • open a pull request on the submodule's repository - we can't open the PR on the main repo until this is merged

You are not done, keep reading! A second pull request is needed to update the main repo, including any other changes to that repo and an update to the submodule pointing to the new (merged) commit to use.

  • open your PR for this change including any changes to the main project (so we don't lose it) but label it "don't merge" and add the URL of the submodule PR we're waiting for
  • once the submodule has the change you need on its master branch, change into the subdirectory and git pull
  • change directory back up to the root of the project
  • commit the submodules changes
  • push these changes too
  • Now we can review your PR

Bringing submodule changes into NDP

If you made changes on the repo outside of NDP, then you will need to come and make a commit on NDP to update which commit in the submodule the NDP repository is pointing to.

Make a branch, change into the submodule directory and git pull or do whatever you need to do to get HEAD pointing to the correct commit. In the top level of the project, add the change to the submodules file and commit and push. Then open the pull request as you would with any other changes.

Further advice and resources for successful submodule usage

Never git add . this is lazy practice anyway but will make bad things happen with submodules. Try git add -p instead. You're welcome.

If you're not sure what to do, ask for help. It's easier to lend a hand along the way than to rescue it later!

Git docs for submodules: https://git-scm.com/book/en/v2/Git-Tools-Submodules

A flow chart on surviving submodules from @lornajane: https://lornajane.net/posts/2016/surviving-git-submodules

Troubleshooting

I'm having issues with my Docker container

The image may have changed, try rebuilding it with the following command:

$ docker-compose up --build

I get an exception PG::ConnectionBad - could not connect to server: Connection refused when I try to run the app.

This error indicates that PostgreSQL is not running. If you installed PostgreSQL using brew you can get information about how to start it by running:

$ brew info postgresql

Once PostgreSQL is running you'll need to create and migrate the database. See Setup for instructions.

Contributing

We ❤️ contributions from everyone! It is a good idea to talk to us first if you plan to add any new functionality. Otherwise, bug reports, bug fixes and feedback on the library is always appreciated. Look at the Contributor Guidelines for more information and please follow the GitHub Flow.

contributions welcome GitHub contributors

License

This library is released under the MIT License