{"id":19312198,"url":"https://github.com/bigcommerce/aspnetcore-react-sample-app","last_synced_at":"2025-04-12T11:23:04.545Z","repository":{"id":44842298,"uuid":"310072920","full_name":"bigcommerce/aspnetcore-react-sample-app","owner":"bigcommerce","description":"🏪 Sample BigCommerce App Using ASP.NET Core and React","archived":false,"fork":false,"pushed_at":"2022-01-22T06:19:15.000Z","size":649,"stargazers_count":2,"open_issues_count":6,"forks_count":3,"subscribers_count":40,"default_branch":"main","last_synced_at":"2025-03-26T06:11:27.100Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C#","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/bigcommerce.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}},"created_at":"2020-11-04T17:33:10.000Z","updated_at":"2024-04-03T02:47:38.000Z","dependencies_parsed_at":"2022-08-28T03:02:43.888Z","dependency_job_id":null,"html_url":"https://github.com/bigcommerce/aspnetcore-react-sample-app","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Faspnetcore-react-sample-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Faspnetcore-react-sample-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Faspnetcore-react-sample-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Faspnetcore-react-sample-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigcommerce","download_url":"https://codeload.github.com/bigcommerce/aspnetcore-react-sample-app/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248558512,"owners_count":21124300,"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":[],"created_at":"2024-11-10T00:33:33.802Z","updated_at":"2025-04-12T11:23:04.518Z","avatar_url":"https://github.com/bigcommerce.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ASP.NET Core React App for BigCommerce\n\nThis is a basic BigCommerce app with two screens, a catalog summary view and list of orders that can be cancelled, built using ASP.NET Core and React. It uses BigCommerce's design library, [BigDesign](https://developer.bigcommerce.com/big-design/).\n\nIt's meant to fast track your ability to take a concept for an app to something usable within the BigCommerce control panel. A live store can install this app while it runs locally.\n\n![Demo](https://user-images.githubusercontent.com/20454870/99060065-29be4180-25a8-11eb-8cec-7e20c14cb0a9.gif)\n\n## Installation\n\nBefore jumping in, you'll want to make sure you have the system requirements met:\n\n- C# and ASP.NET Core ([Installation Guide](https://docs.microsoft.com/en-us/visualstudio/get-started/csharp/tutorial-aspnet-core?view=vs-2019))\n- Node.js ([Installation Guide](https://nodejs.org/en/))\n- Local SSL Cert ([Installation Guide](https://www.hanselman.com/blog/developing-locally-with-aspnet-core-under-https-ssl-and-selfsigned-certs))\n\nTo test on a BigCommerce store, you can create a free trial on bigcommerce.com or request a free sandbox store by [signing up to be a tech partner](https://www.bigcommerce.com/partners/).\n\n## Usage\n\nTo run the app:\n\n```bash\ndotnet run\n```\n\nAfter compiling the app should be reachable at the site you are hosting the app on locally. i.e https://localhost:9457/\n\n### Environment\n\nSet the following environment variables (or add a `.env` file):\n\n```\n# Existing env variable. Make sure it matches the base URL of your app\nAPP_URL=https://localhost:9457\n\n[ ... other existing variables ... ]\n\n# New env variables for BC app and a test API credentials for local dev\n# The Client ID and Secret can be found at https://devtools.bigcommerce.com/my/apps by selecting 'View Client ID'\nBC_APP_CLIENT_ID=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\nBC_APP_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n\n# These local credentials can be created by creating an API Account within your BigCommerce store (Advanced Settings \u003e API Accounts)\nBC_LOCAL_CLIENT_ID=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\nBC_LOCAL_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\nBC_LOCAL_ACCESS_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\nBC_LOCAL_STORE_HASH=stores/xxxxxxxxxxx\n```\n\nWhen running the app outside of BigCommerce, setting the follow environment variable will cause the app to use the local API credential (also in the .env file):\n\n```\nAPP_ENV=local\n```\n\nLikewise, setting it to production will use only the credentials received during the OAuth handshake when the app is install on the BigCommerce store:\n\n```\nAPP_ENV=production\n```\n\n## Quick start demo with Docker\n\n###### For local testing only\n\nTo quickly see the app in action with your credentials, run the following command:\n\n```bash\ndocker run -d --restart=unless-stopped \\\n    -p 80:80 -p 443:443 \\\n    -e BC_LOCAL_CLIENT_ID=\u003cYOUR_BC_LOCAL_CLIENT_ID\u003e \\\n    -e BC_LOCAL_SECRET=\u003cYOUR_BC_LOCAL_SECRET\u003e \\\n    -e BC_LOCAL_ACCESS_TOKEN=\u003cYOUR_BC_LOCAL_ACCESS_TOKEN\u003e \\\n    -e BC_LOCAL_STORE_HASH=\u003cYOUR_BC_LOCAL_STORE_HASH\u003e \\\n    yardenshoham/aspnetcore-react-sample-app:demo\n```\n\nThen, go to https://localhost.\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigcommerce%2Faspnetcore-react-sample-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigcommerce%2Faspnetcore-react-sample-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigcommerce%2Faspnetcore-react-sample-app/lists"}