https://github.com/dnsimple/hello-domains-hanami

Hello Domains, the Hello World for the DNSimple API, implemented with Ruby & Hanami
https://github.com/dnsimple/hello-domains-hanami

dnsimple-policy-eng

Last synced: 3 months ago
JSON representation

Hello Domains, the Hello World for the DNSimple API, implemented with Ruby & Hanami

• Host: GitHub
• URL: https://github.com/dnsimple/hello-domains-hanami
• Owner: dnsimple
• Archived: true
• Created: 2016-12-09T08:33:00.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2021-10-29T13:17:32.000Z (about 3 years ago)
• Last Synced: 2024-06-03T21:03:03.252Z (5 months ago)
• Topics: dnsimple-policy-eng
• Language: Ruby
• Homepage: https://developer.dnsimple.com
• Size: 58.6 KB
• Stars: 4
• Watchers: 8
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Hello Domains with Hanami

This is a full working example project to create a DNSimple addon with Hanami.

## Prerequisites

  * Ruby 2.3+ (with OpenSSL)

  * PostgreSQL 9.4+

  * A DNSimple [sandbox](https://developer.dnsimple.com/sandbox) account

  * A DNSimple [OAuth Application](https://support.dnsimple.com/articles/oauth-applications/) on sandbox

The OAuth Application has a `Client ID` and a `Client Secret` that you should use to setup this project.

## Setup

To setup this project, please use the following commands:

```shell

➜ git clone https://github.com/dnsimple/hello-domains-hanami.git

➜ cd hello-domains-hanami

➜ ./bin/setup [DNSIMPLE_CLIENT_ID] [DNSIMPLE_CLIENT_SECRET]

➜ bundle exec hanami server # visit http://localhost:2300

```

### Development

By default, _Hello Domains_ targets DNSimple Sandbox.

If you need, for development purposes, to interact with a different DNSimple stage, please edit the following env vars in `.env.development`

  * `DNSIMPLE_BASE_URL`

  * `DNSIMPLE_AUTHORIZE_URL`

  * `DNSIMPLE_TOKEN_URL`

## Testing

To run the tests please run:

```shell

➜ bundle exec rake

```

## Copyright

Copyright (c) 2017 Aetrion LLC.