Skip to content

atomicjolt/atomic-search-widget

Repository files navigation

Atomic Search Widget Build Status Coverage Status

This application adds a search widget to Canvas.

Install into Canvas:

Follow these instructions to install into Canvas

Getting Started with Development:

Make sure to install git, npm and yarn before you start then:

  1. git clone https://github.com/atomicjolt/react_client_starter_app.git my_project_name

  2. Rename .env.example to .env. This file contains the port the server will use. The default 8080 should be fine, but you can also use a local domain or ngrok if you wish.

  3. run ./bin/setup or ./bin/setup-linux

  4. Install packages with

    yarn

  5. Start server with:

yarn hot

  1. Upload the file loaders/local.js as your canvas theme js (Do this in a subaccount or on test or beta canvas). It's a small snippet that simply loads the js from the webpack server.

Check for updates

Inside the client directory run:

yarn upgrade-interactive

Scripts:

Run webpack hot reload server: yarn hot

Release a production build to the S3 website bucket env is dev, beta, or prod: yarn release [env]

Run a linter over the project: yarn lint

Run a linter over the project: yarn lint

Deploy

If you have multiple aws profiles and need to use a specific one you can do so by setting the AWS_PROFILE i.e. AWS_PROFILE=atomicjolt yarn release dev

License and attribution

MIT