From 199b5bfb9f116c062752188d2de4212ae8557bfd Mon Sep 17 00:00:00 2001 From: Stefan Topfstedt Date: Thu, 15 Feb 2024 12:55:23 -0800 Subject: [PATCH] updates LTI course manager specific READMe. --- packages/lti-course-manager/README.md | 61 +++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 packages/lti-course-manager/README.md diff --git a/packages/lti-course-manager/README.md b/packages/lti-course-manager/README.md new file mode 100644 index 0000000000..7986ce8f8a --- /dev/null +++ b/packages/lti-course-manager/README.md @@ -0,0 +1,61 @@ +# LTI Course Manager + +Learning Tools Interoperability (LTI) application for the Ilios course manager. + +## Directions for developers working with this ember-cli app + +### Prerequisites + +You will need the following things properly installed on your computer. + +* [Git](https://git-scm.com/) +* [Node.js](https://nodejs.org/) +* [PNPM](https://pnpm.io) +* [Ember CLI](https://cli.emberjs.com/release/) +* [Google Chrome](https://google.com/chrome/) + +### Installation + +* `git clone git@github.com:ilios/frontend.git` +* `cd frontend` +* `pnpm install` + +### Running / Development + +* `ILIOS_FRONTEND_API_HOST=https://ilios3-demo.ucsf.edu pnpm start:lti-course-manager` +* Visit your app at [http://localhost:4200](http://localhost:4200). +* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests). + +#### Code Generators + +Make use of the many generators for code, try `ember help generate` for more details + +### Running Tests + +* `pnpm test:lti-course-manager` +* `pnpm test:lti-course-manager --server` + +### Linting + +* `pnpm run lint:hbs` +* `pnpm run lint:css` +* `pnpm run lint:js` +* `pnpm run lint:js --fix` + +### Building + +* `pnpm --filter lti-course-manager exec ember build` (development) +* `pnpm --filter lti-course-manager exec ember build --environment production` (production) + + +### Deploying + +Specify what it takes to deploy your app. + +### Further Reading / Useful Links + +* [ember.js](https://emberjs.com/) +* [ember-cli](https://cli.emberjs.com/release/) +* Development Browser Extensions + * [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi) + * [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)