Emoji-Feedback 😀 😞 😕 👍 👎 (in active development)
These instructions will get you a copy of the project up and running on your local machine.
Installing and Setup
- First, clone this repo.
git clone https://github.com/ubc/emoji-feedback.git
- Then cd into the repo.
- Run the installation script.
npm install(If you see
babel-node: command not found, you've missed this step.)
- Run using
npm start. Webpack Dev Server will host a hot-loading webpage.
- To build for production,
npm run buildwill output the production-ready, minified, tree-shaken bundle in
Emoji-Feedback can be configured in
index.js by importing
app.js and instantiating it.
A very basic config is outlined below:
const emojiFeedback =const endpoints =emoji: ''feedback: ''votes: ''emojiFeedback
emojiFeedback has one method,
It takes 3 arguments:
entryis the HTML id attribute that should be unique to the document. This is the entry point of Emoji Feedback.
endpointsis an object that contains 3 endpoints
feedbacksend POST requests that contain the selected emoji(s) and the written feedback in the body of the request, respectively.
votessends a GET request for retrieving the number of times students have voted.
optionsis an optional object that contains
feedbackThankYou, which allow for configurations of the text.
To run the tests, first ensure that the application is running locally (
npm start), then
npm test will run the Jest unit and UI tests (in Puppeteer's headless mode).
Code coverage is >90%, and more tests will be added over time.