Skip to content

Latest commit

 

History

History
96 lines (80 loc) · 7.16 KB

readme.md

File metadata and controls

96 lines (80 loc) · 7.16 KB
Raw

Atomic Insight

Client Build Server Build

Atomic Insight is a tool that ingests events from Canvas and provides a custom dashboard experience via a LTI tool. Data is produced via a plugin for Canvas, then ingested using Go. The LTI is backed by Go as well, with a React front-end that interacts with the back-end API via GraphQL.

Setup

To get set up, follow these steps in order.

0: Dependencies

If you are using asdf, just run asdf install after the clone step in the environment setup. Otherwise, just make sure you have PostgreSQL, NodeJS, and the GoLang dev environment set up for this project. You will also need nginx, but that is covered in the following install steps.

Note: These instructions assume you are either on MacOS or a Debian-based Linux distribution.

1: Environment setup

  • Clone this repo down
  • Create the development and test database with createdb atomic_insight_dev and createdb atomic_insight_test
  • Copy server_config.example.json to server_config.json and update values inside appropriately
    • These can be left as the default, unless you would like to change it:
      • db_user
      • db_host
      • database
      • server_port
    • client_id: You will need to set up a new LTI key for your dev environment, so see the instructions for that
    • auth0_client_id: This can be left alone, or set to something you choose. It just identifies your client when doing the Open ID Connect process to initiate an LTI Advantage Launch with Canvas.
    • autho0_client_secret: For production, this of course needs to be kept secret, but for dev you could just use the default value. If you want, you can generate a new random secret and replace the existing one.
  • Copy .env.example to .env. Note that nothing sources .env automatically yet, so this is more or less a no-op. The lack of an ATOMIC_INSIGHT_ENV environment variable being set makes the app default to the development environment.
    • The three supported environments are development, test, and production

2: SSL/Web Stack Setup:

  • Run the nginx setup script in ./bin/setup (you will need nginx configured with SSL certificates for atomicjolt.xyz)
    • If you haven't done this yet, the setup script is in our shared Dropbox folder $DROPBOX/aj-dev/atomicjolt/local-development (setup is for MacOS, and setup-linux is for Debian based systems, but you could copy and modify it for other systems)
  • Install client dependencies first with cd client to be in the right directory, then yarn to install dependencies
  • Create a client build with yarn build in the client directory
  • Run the server with go run server.go in the project root (to view the project, you will need to install it as an LTI tool)

3: LTI Tool Install

  • This tool is installed via LTI Advantage. This means that you will need to generate a new LTI key.
    • A note: LTI keys normally identify an OAUTHv2 relationship with an LMS for the establishment of durable API tokens. For whatever reason, LTI keys can also represent a LTI tool install. This was a decision that the Canvas devs made and stuck with.
  • Head to the Canvas admin panel for the main account and navigate to the "Developer Keys" section on the left sidebar.
  • Add a new developer key and fill out the application settings
  • Save your LTI key
  • Enable your LTI key (turn the State toggle in the key list from Off to On)
  • Copy the Client ID from your key (the top number above the Show Key button) and put that into your server_config.json for both the development and test environments.
  • Head to the course you will be testing in and install a new tool via Client ID by pasting this client ID into the install form.

4: Database setup:

  • Run any migrations with ./bin/migrate migrate
  • Run any seeds with ./bin/seed (this is not idempotent, running it multiple times will create duplicate data)

5: Running

  • Make sure you are running go run server.go in the project root and have run yarn build in the client folder
    • To enable hot reload for the client, run yarn start in the client directory, and make sure to set the environment variable: ATOMIC_INSIGHT_ENV=development
    • If you have entr installed, you can run find . -name "*.go" | entr -cr go run server.go or similar to enable hot reload for the server
  • Navigate to your test course and open up Atomic Insight on the sidebar, and the tool should launch

Development

Graphql

This project used gqlgen to generate code for a graphql server. Documentation can be found at https://gqlgen.com/.

Configuration

The locations for generated code, mappings between graphql types and go types, and other configuration values are in gqlgen.yml

Schema

When the graphql schema is changed, the generated code needs to be updated with go generate ./...

Canvas Events

This project expects canvas live events to be sent via a signed jwt using POST requests, which is not the default behavior. In order for this to work an initializer must be added to the canvas instance, and live events must be configured:

  • run ./bin/install_initializer.sh path/to/canvas/
  • In the initializer, set the correct url to send events to
    • If using vagrant to run canvas, add a private network to the vagrantfile: config.vm.network "private_network", ip: "192.168.33.10"
  • In the Canvas admin page, enable the live events plugin and set the stream name to "stubbed_kinesis_stream"