{"id":19312205,"url":"https://github.com/bigcommerce/ruby-rails-react-sample-app","last_synced_at":"2025-07-17T00:31:40.518Z","repository":{"id":44842270,"uuid":"314614517","full_name":"bigcommerce/ruby-rails-react-sample-app","owner":"bigcommerce","description":"BigCommerce App - Ruby on Rails + React + BigDesign","archived":false,"fork":false,"pushed_at":"2022-12-25T21:42:11.000Z","size":619,"stargazers_count":3,"open_issues_count":8,"forks_count":4,"subscribers_count":43,"default_branch":"main","last_synced_at":"2025-06-06T14:05:10.593Z","etag":null,"topics":["bigcommerce","rails","react","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"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":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-20T16:50:13.000Z","updated_at":"2024-09-21T06:04:05.000Z","dependencies_parsed_at":"2023-01-30T22:46:23.214Z","dependency_job_id":null,"html_url":"https://github.com/bigcommerce/ruby-rails-react-sample-app","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/bigcommerce/ruby-rails-react-sample-app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fruby-rails-react-sample-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fruby-rails-react-sample-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fruby-rails-react-sample-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fruby-rails-react-sample-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigcommerce","download_url":"https://codeload.github.com/bigcommerce/ruby-rails-react-sample-app/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fruby-rails-react-sample-app/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265554774,"owners_count":23787279,"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":["bigcommerce","rails","react","ruby"],"created_at":"2024-11-10T00:33:35.538Z","updated_at":"2025-07-17T00:31:40.500Z","avatar_url":"https://github.com/bigcommerce.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sample Ruby on Rails App w/ React FE for BigCommerce\n\n## Requirement\n- Ruby `2.7.1`\n- Rails `6.0.3`\n- Postgresql\n- Node.js\n- React\n\n## Software\n- [RVM](https://rvm.io/)\n- [Postgres App](https://postgresapp.com/)\n- [ngrok](https://ngrok.com/)\n\n## Install Dependencies (First time only)\n- Install ruby v2.7.1 using: `rvm install 2.5.1` (Ruby version missed only)\n- Install rails dependencies: `bundle install`\n- Install node dep: `yarn`\n\n## Issues while installation:\n- Error: `An error occurred while installing pg (0.21.0), and Bundler cannot continue.`\n- Solution: Install using: `gem install pg -v '0.21.0' -- --with-pg-config=/Applications/Postgres.app/Contents/Versions/12/bin/pg_config`\n\n## Database creation \u0026 initialization\n- `rake db:create`\n- `rake db:migrate`\n\n## Creating the BigCommerce App\n\n- Go to https://devtools.bigcommerce.com/\n- Create a new app\n- Within the technical details step, use these callback urls\n  - Auth Callback: `https://{{base-app-url}}/auth/bigcommerce/callback`\n  - Load Callback URL: `https://{{base-app-url}}/load`\n  - Uninstall Callback URL: `https://{{base-app-url}}/uninstall`\n\n## ENV variables\nWe need to set `NGROK_FORWARDED_URL` before starting Rails Server\n\n- Create file `config/application.yml`\n```.env\n\nAPP_NAME: \"BigCommerce App\"\nBC_CLIENT_SECRET: \"SECRET\"\nBC_CLIENT_ID: ‘BC_CLIENT_ID’\nAPP_URL: \"NGROK_FORWARDED_URL\"\n```\n\n## Development Instructions\n- Install [Foreman](https://mattstauffer.com/blog/using-a-procfile-to-streamline-your-local-development/) one time only - `gem install foreman`\n- Open Postgres App, Redis App\n- Open a new tab and run ngrok: `ngrok http 3000`\n- Edit `APP_URL` in `config/application.yml` value to forwarded ngrok url without the protocol (i.e c75b5744dxxx.ngrok.io)\n- Config forwarded ngrok url in BigCommerce app dashboard.\n- Open forwarded ngrok url and login a development store\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigcommerce%2Fruby-rails-react-sample-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigcommerce%2Fruby-rails-react-sample-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigcommerce%2Fruby-rails-react-sample-app/lists"}