vtimofei
/
surfingkeys-conf
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
surfingkeys-conf/lambda
History
Maddison Hellstrom 26f155f1da [deps] upgrade npm dependencies 2019-11-10 05:09:54 -08:00
..
scripts feat: add AWS lambda API proxy server 2018-11-21 03:05:41 -08:00
README.md docs: use prettier shields.io badge style 2018-11-27 16:38:53 -08:00
app.js feat: add AWS lambda API proxy server 2018-11-21 03:05:41 -08:00
claudia.json feat: add AWS lambda API proxy server 2018-11-21 03:05:41 -08:00
index.js docs(lambda): add README and comment entrypoints 2018-11-21 04:15:50 -08:00
lambda.js docs(lambda): add README and comment entrypoints 2018-11-21 04:15:50 -08:00
package.json [deps] upgrade npm dependencies 2019-11-10 05:09:54 -08:00
yarn.lock [deps] upgrade npm dependencies 2019-11-10 05:09:54 -08:00

README.md

Commitizen friendly Liberapay contributions

sk-proxy

sk-proxy is a proxy server for external APIs which need more complicated processing and/or authentication which are not feasible to implement in client-side code alone.

External API Support

Current API Version: v1.0.0

Currently, sk-proxy supports the following APIs:

  • domainr:
    • Search by query, returning a list of domain suggestions with their registration statuses: GET /v1/domainr?q=domain_query

Hosting

An instance of sk-proxy is being hosted by b0o for free community use. It is located at:

https://5jmgqstc3m.execute-api.us-west-1.amazonaws.com/v1/

The proxy instance is configured with a low global monthly rate limit - please don't abuse it or it will be made private ;)

Deploy

Requirements:

  • a properly configured surfingkeys-conf in the parent directory (RTFM)
  • node
  • aws-cli
  • claudia (globally installed with npm)

  1. Install Node Packages

    $ cd surfingkeys-conf/lambda
$ npm install

  2. Create Lambda function with Claudia

    $ npm run create

  3. Deploy to Lambda with Claudia

    $ npm run deploy

Support

This code is offered as a courtesy.

No support will be provided in deploying or troubleshooting AWS services.

Please, only open an issue for actual bugs relating to the code published here.

License

© 2018 Maddison Hellstrom

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.