Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.57 KB

README.md

File metadata and controls

47 lines (31 loc) · 1.57 KB

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 and npm before you start then:

  1. git clone https://github.com/atomicjolt/atomic-search-widget.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

    npm install

  5. Start server with:

npm run 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.

Scripts:

Run webpack hot reload server: npm hot

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

Run a linter over the project: npm 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 npm run release dev

License and attribution

MIT