Skip to content

Latest commit

 

History

History
77 lines (55 loc) · 5.09 KB

README.md

File metadata and controls

77 lines (55 loc) · 5.09 KB
Raw

AI App Foundation

This single-click app presents BigCommerce merchants with the ability to generate product descriptions.

🌟 If you are hacking right now in the Google <> BigCommerce AI Hackathon event, check out our Hackpack for more detail on Vertex AI and BigCommerce App Extensions! 🌟

Install

  1. Use Node 18+ and NPM 8+
  2. Install npm packages
    • npm install

Usage

To run the app locally, follow these instructions:

  1. Add and start ngrok. Note: use port 3000 to match Next's server.
    • ngrok http 3000
    • Get the ngrok_id from the Forwarding row. You will use it in the next step.
  2. Register a draft app.
    • Enter app callbacks using the following syntax:
      • Auth Callback URL: https://{ngrok_id}.ngrok.app/api/app/auth, for example https://12345.ngrok.app/api/app/auth
      • Load Callback URL: https://{ngrok_id}.ngrok.app/api/app/load
      • Uninstall Callback URL: https://{ngrok_id}.ngrok.app/api/app/uninstall
    • Configure the following OAuth scopes as directed in Setup:
  3. Copy .env.example to .env.
  4. Replace CLIENT_ID and CLIENT_SECRET in .env (from View Client ID in the dev portal).
  5. Update AUTH_REDIRECT in .env with the ngrok install callback URL.
  6. Enter a JWT secret in .env.
    • JWT key should be at least 32 random characters (256 bits) for HS256
  7. Replace FIRE_API_KEY, FIRE_DOMAIN and FIRE_PROJECT_ID in .env
  8. Replace GOOGLE_API_KEY= in .env
  9. Start your dev environment in a separate terminal from ngrok. If ngrok restarts, update callbacks in steps 2 and 5 with the new ngrok_id.
    • npm run dev
  10. Install the app and launch.

Deploy with Vercel

Deploy with Vercel

Contributing

Please feel free to ask questions or raise issues in GitHub Issues/Discussions.

Security

To enhance security, include a CSRF token for sensitive actions (e.g., modifying product descriptions) or operations that might generate load or costs (such as AI prompts). This will provide an extra layer of protection and ensure proper authorization.

Learn more

The BigCommerce platform

Looking to help the world's leading brands and the next generation of successful merchants take flight? To learn more about developing on top of the BigCommerce platform, take a look at the following resources:

License

Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved

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.