mark-watson-lrn/bootcamp_demo

An exploration into Learnosity's API's as part of Learnosity's induction / bootcamp program.

Bootcamp Demo Quiz

Author API and Reports API

Table of Contents

1. Project Description
2. User Story
3. Acceptance Criteria
4. Installation
5. Usage
6. Credits
7. License
8. Repository Status
9. Contribute
10. Tests
11. Checklist

---

1. Description

What is this project?

• An exploration into Learnosity's products from the client / customer viewpoint. A team effort between Kuleena Binoy and Mark Watson.

Why this project?

• It was decided to pick a topic where we could sample the different Item Editing features so we randomly chose the topic of Proteins.

---

2. User Story

• AS a Learnosity customer
• I WANT to be able to easily implement Learnosity's products into my web application
• SO THAT I can set tests as specified by my clients.

3. Acceptance Criteria

• GIVEN a landing page.
• WHEN I select 'Start'.
• THEN a quiz on proteins is rendered to my page.
• WHEN I complete the quiz I can save and exit from the quiz.
• AND I am presented with the result of my quiz.

---

4. Installation

You are welcome to download the source code from Github repository

Once downloaded, you will need to install the dependencies with the following command in your terminal:

npm install

You will then need to add your API keys into a .env file. I've left a template in the repository for you to follow.

Once you have created a .env file with your API keys you can run the application, type in the command line:

npm start develop

Enjoy.

---

5. Usage

The code can be downloaded from my Github repository for all assets created for the project.

You are welcome to modify the code as you need as allowed by the license

---

6. Credits

• Learnosity's SDK: https://help.learnosity.com/hc/en-us/articles/360000758737-Node-JS-SDK

---

7. License

The works in this repository are subject to:

---

8. Github repo status

---

9. How to Contribute

If you would like to contribute, please comply with the Contributor Covenant Code of Conduct:

---

10. Tests

• No tests have been prepared for this application.

---

11. Checklist

All actions not checked are still to be completed:

[x] This application satisfies the acceptance criteria.
[x] Application is deployed to Heroku proteins-lrn.herokuapp.com.
[x] Application loads with no errors.
[x] User experience is intuitive and easy to navigate.
[x] User interface style is clean and polished.
[x] GitHub repository contains application code. [x] Application is deployed to GitHub Pages: Github location: https://github.com/mark-watson-lrn/bootcamp_demo
[x] Repository has a unique name.
[x] Repository follows best practices for class/id naming conventions, indentation, quality comments, etc.
[x] Repository contains multiple descriptive commit messages.
[x] Repository contains quality README file with description, screenshot, and link to deployed application: Github location: https://github.com/mark-watson-lrn/bootcamp_demo.

---

Back to the top