{"id":18810987,"url":"https://github.com/shipengine/shipenguin_web_app","last_synced_at":"2025-07-11T00:38:21.633Z","repository":{"id":93052038,"uuid":"281240945","full_name":"ShipEngine/shipenguin_web_app","owner":"ShipEngine","description":"The source code for the Shipenguin web app, this project serves as a reference implementation of address validation, rates, and labels powered by ShipEngine.","archived":false,"fork":false,"pushed_at":"2020-10-01T17:48:24.000Z","size":7020,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-22T03:11:15.439Z","etag":null,"topics":["address-validation","rest-api","sample-app","shipping","shipping-api","shipping-label","shipping-rates"],"latest_commit_sha":null,"homepage":"https://shipenguin-dev.herokuapp.com/","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ShipEngine.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-20T22:46:04.000Z","updated_at":"2023-07-19T09:34:58.000Z","dependencies_parsed_at":"2023-04-25T14:31:25.388Z","dependency_job_id":null,"html_url":"https://github.com/ShipEngine/shipenguin_web_app","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ShipEngine/shipenguin_web_app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShipEngine%2Fshipenguin_web_app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShipEngine%2Fshipenguin_web_app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShipEngine%2Fshipenguin_web_app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShipEngine%2Fshipenguin_web_app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ShipEngine","download_url":"https://codeload.github.com/ShipEngine/shipenguin_web_app/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShipEngine%2Fshipenguin_web_app/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264697567,"owners_count":23650955,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["address-validation","rest-api","sample-app","shipping","shipping-api","shipping-label","shipping-rates"],"created_at":"2024-11-07T23:23:41.828Z","updated_at":"2025-07-11T00:38:21.611Z","avatar_url":"https://github.com/ShipEngine.png","language":"CSS","readme":"# Shipenguin Web App (In Development)\n\n- See it action here: https://shipenguin-dev.herokuapp.com/\n\nThis is a reference implementation of the following ShipEngine API services:\n* Address Validation\n* Shipping Rates\n* Shipping Labels\n\n- The first step to run this source code locally, will be creating a `.env` file in the project directory. You can copy the contents of [.env.example](./.env.example \"Environment Variable Template\") and add in your own values before starting the server.\n    \n    * *Note:* You will need to create a free [ShipEngine Account](https://www.shipengine.com/signup \"Create a ShipEngine Account\") to obtain Sandbox and Production API Key's and carrier_id's to run this application successfully.\n    \n- Next, you will install the projects' dependencies at the command line.\n\n    ```npm\n    npm install \u0026\u0026 npm start\n    ```\n- Go to the server address in your browser `https://\u003cngrok_hash\u003e.ngrok.io/` listening on port `8000`. When you run `npm start` you will see the server address provided in your terminal.\n\n- This app also uses [Stripe](https://stripe.com/docs \"Stripe Developer Portal\") for payments. \n    * You can use the following test card information to pay for the label: \n    * `4242 4242 4242 4242` `CVV:\u003cany 3 digits\u003e` `EXP:\u003cany future date\u003e` `ZIPCODE:\u003cany 6 digits\u003e`\n    \n## Local Development\nWhen running this code in development mode if you do not have an NGROK account, use the following npm script:\n```npm\nnpm run dev\n```\n- This runs with the `NODE_ENV` set to `production`  because there is logic in [server/node/config.js](./server/node/config.js \"Local config.js file\") on line 74.\n    \nIf you have an NGROK account and have added your NGROK authtoken to your `.env` file, use the following npm script:\n```npm\nnpm run dev:ngrok\n```\n- This runs with the `NODE_ENV` set to `development` to trigger the NGROK config to use your NGROK authtoken and subdomain. \n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshipengine%2Fshipenguin_web_app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshipengine%2Fshipenguin_web_app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshipengine%2Fshipenguin_web_app/lists"}