PkgFoundry
Catalog npm
Back to packageRELEASE DETAILS

0.0.6

npm

@0bdx/srv-api

A simple JSON API in Node.js which works with Mongo-like databases.

apiawsmongodbstarter
Published13 Apr 2023
Direct dependencies6
Transitive dependenciesNot calculated

README

Current package documentation

@0bdx/srv-api

A simple JSON API in Node.js which works with Mongo-like databases.

∅  Version: 0.0.8
∅  NPM: https://www.npmjs.com/package/@0bdx/srv-api
∅  Repo: https://github.com/0bdx/srv-api
∅  AWS Billing Dashboard: https://eu-central-1.console.aws.amazon.com/billing
∅  App Runner Console: https://eu-central-1.console.aws.amazon.com/apprunner

Running locally

To use port 1234 (instead of 8080, the default):
$ PORT=1234 npm start

AWS billing

All prices here are before tax.

GitHub connections billing

As far as I can tell, ‘GitHub connections’ do not appear on the AWS invoice, and are not charged for.

Bandwidth billing

Bandwidth falls under the year-long free tier, and memory-usage does not seem to be charged-for:

  • Bandwidth $0.000 per GB - data transfer out under the monthly global free tier 0.002 GB = USD 0.00

App Runner billing

App Runner is fairly cheap. You are charged by the hour, with separate charges for the ‘build’ service, and the ‘run’ service. The ‘run’ service is divided into ‘provisioned’ (which I think is “up time”), and a charge for CPU time.

On the free tier, while developing this repo, I recreated the app maybe twelve times, so the ‘build’ charge is much higher than a real app would be:

  • USD0.005 per Mins for AppRunner-Build-mins in EU (Frankfurt) 21 Mins = USD 0.11
  • AWS App Runner - Provisioned - GB-hours - EU (Frankfurt) 8.122 hours = USD 0.07
  • USD0.074496 per vCPU-hour for AppRunner-vCPU-hours:RunService in EU (Frankfurt) 0.004 vCPU-hour = USD 0.00

Note that ‘Automatic deployments’ could cost $1 per application per month.
I did try using these, but didn’t see a charge appear on my bill yet.

Bandwidth billing

Bandwidth falls under the year-long free tier, and memory-usage does not seem to be charged-for:

  • Bandwidth $0.000 per GB - data transfer out under the monthly global free tier 0.002 GB = USD 0.00

CloudWatch billing

There’s a free log-monitoring service called CloudWatch which could probably be switched off (the App Runner console provides logs you can manually refresh):

  • Amazon CloudWatch 0.00 per alarm metric month - first 10 alarm metrics 0.001 Alarms = USD 0.00
  • AmazonCloudWatch EUC1-TimedStorage-ByteHrs First 5GB-mo per month of logs storage is free. 0 GB-Mo = USD 0.00
  • AmazonCloudWatch PutLogEvents First 5GB per month of log data ingested is free. 0 GB = USD 0.

Set up AWS

Set up the GitHub connection

Click ‘GitHub connections’ in the sidebar at https://eu-central-1.console.aws.amazon.com/apprunner.
If this is the first time you’ve used App Runner, it will probably be empty.

Click ‘Create an App Runner service’ at https://eu-central-1.console.aws.amazon.com/apprunner.
Click ‘Source code repository’.
Under ‘Connect to GitHub’, click ‘Add new’.
Wait for a new window to open (disable your popup-blocker browser extension).

  • Connection name: srv-api--cnx
  • GitHub app: Allow AWS to connect to your GitHub account

After clicking ‘Next’, and clicking ‘GitHub connections’ in the sidebar again, you should see srv-api--cnx listed.

Set up the App Runner instance

This app is set to deploy from main, manually (so, pushes to main do not automatically deploy a new version of the service).

Click ‘Create an App Runner service’ at https://eu-central-1.console.aws.amazon.com/apprunner.

  • Repository type: Source code repository
  • Connect to GitHub: srv-api--cnx • srv-api • main
  • Deployment trigger: Manual (or Automatic, which costs $1 per application per month)
  • Configuration file: Configure all settings here
  • Runtime: Nodejs 16
  • Build command: npm install (should only install deps, not †he dev-deps)
  • Start command: npm start (or npm start -- -dvw while debugging)
  • Port: 8080
  • Service name: srv-api-App-Runner-Instance
  • Virtual CPU & memory: 1 vCPU • 2 GB
  • Health check: Path: / (which MUST respond with a 200 HTTP status)
  • Health check: Interval: 20 (once every 20 seconds is the maximum AWS allows)

…and keep the defaults for all the other settings.
Click ‘Next’ and then ‘Create and deploy’.
w

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 6

Native requirements
6 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
@0bdx/ainta
Environment
{
  "local_name": "@0bdx/ainta",
  "alias": false,
  "peer_metadata": null
}
^0.0.15runtime
@0bdx/build-helpers
Environment
{
  "local_name": "@0bdx/build-helpers",
  "alias": false,
  "peer_metadata": null
}
^0.0.4development
@0bdx/cli-config-helpers
Environment
{
  "local_name": "@0bdx/cli-config-helpers",
  "alias": false,
  "peer_metadata": null
}
^0.0.1development
@rollup/plugin-node-resolve
Environment
{
  "local_name": "@rollup/plugin-node-resolve",
  "alias": false,
  "peer_metadata": null
}
^15.0.2development
@types/node
Environment
{
  "local_name": "@types/node",
  "alias": false,
  "peer_metadata": null
}
^18.15.3development
rollup
Environment
{
  "local_name": "rollup",
  "alias": false,
  "peer_metadata": null
}
^3.19.1development

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "integrity": "sha512-6fzlavVkLfMLUwLwFawHHdSuCxnijNdGlMXGjJDs9Zhtn125/Ft8Fe+nP0m/HJA6y0z4t9icsGN3iS/vOjLYPg==",
  "shasum": "5911f612bfea09a9d1f153349f097f43f47059fb",
  "tarball": "https://registry.npmjs.org/@0bdx/srv-api/-/srv-api-0.0.6.tgz",
  "fileCount": 5,
  "unpackedSize": 128911,
  "signatures": [
    {
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
      "sig": "MEQCIEtOyBmahZCbvD3csTKOfMt4mb+9cmRz+smIMdwXX8ifAiBJgF7fxL3T+TfKdF8kbw88VyZcq0/RYpw6Ybct4d4IoQ=="
    }
  ],
  "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkN9LpACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoNGQ/9GnFU4K40byP/Z7hnEfc65fCSw5GD6jsrUcg78tIGI6Rf0Yb8\r\nxs26zclx2R5qNSCa9VQkuJ1i9DwYj9kYyA9YCggCXpNa/PR0yiqvUcFob5NF\r\nhaYmuLaRp/f/he+idTEfaefBkj5lmn+/gmjMtEZb+oWDu93WfVO1BJ6Xpyi1\r\nDmxETQqdIM42dFq6clNvuOZ69t5Q8RXhJ7vspoxE6+6ISpBA3maBkLlrwm5J\r\nuW2RiEpYpCN5MGehan+d36cQa+zhzv1llDiSMZ9x+PSRVdvfXNFXl7vdzngz\r\n6L3Lbd+7Kiu79KNgXUzolv7IJQTz5H4JPGI6uCvaM1wx4ab8TxaCwityCicj\r\na2jUyl8jT59jxrLHO11sKDUOgZ4e9sMhw3sRpHo5UXQbsMBs2Kzb0LKwsvbp\r\nfiX6OWg2MMQGDJQFD2X0lLHR05ucy8q2ekzloO3EVrp2RDE76qp4a+/hEu3V\r\nnYzw2Srx/qIifRx055jPQdse7gTrWfmndjT5XFrfvtTOmqYWcpWwcvz7QOXf\r\n79QQ0w0dT89esoCndi9UJ2atA9tMwaQZGVonOv6PmZu0RnHxGxVr1m20dWMI\r\n2TzTr8Sdzv8YbUefIK0AjXUevR5zZcvie6C7plaI3TWvlOiVWIu/RGOia2W7\r\naTx4UCkHTj8EJwZCqQ3GlW3Ai6nnT1LyWa8=\r\n=Ahan\r\n-----END PGP SIGNATURE-----\r\n"
}

Repository

PENDING
0bdx/srv-api

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 22:04 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:e2aa9f9cc1b09bc65877796123659bb145239f91c3f8b1c1aff5fcf993d735a6

Other collected versions

0.0.813 Apr0.0.713 Apr0.0.511 Apr0.0.411 Apr0.0.311 Apr0.0.211 AprView all collected versions →