Skip to content

fangtingliu/spkr

 
 

Repository files navigation

Stories in Ready

Designed for people who need to speak in front of large groups often, SPKR allows presenters to continuously improve on their public speaking skills.

Table of Contents

  1. What is SPKR?
  2. Team
  3. Requirements
  4. Development
    1. Installing Dependencies
    2. Viewing the project
    3. Running tests
  5. Roadmap
  6. Known Bugs
  7. Avenues to explore
  8. Contributing

What is SPKR?

SPKR allows presenters to improve on their public speaking abilities by way of crowdsourcing audience feedback. SPKR generates a unique link to a feedback form for a speaker's presentation that they can provide to audience members at the end of a talk. Audience members will be able to access the feedback form and rate the speaker's performance on criteria ranging from audience connection to body language. Once logged in, presenters will be able to track their overall rating on a specific criteria for a specific presentation as well as their improvement over multiple presentations. This feedback cycle lets users know what they are good at, what they can improve on, and if any changes in the way they present are accomplishing their goals. More information can be found here

Team

  • Product Owner: juan
  • Scrum Master: fangtingprahl
  • Development Team Members: ematsusaka, trsreagan3, vahagnst, gato-gordo, sdxl

Requirements

  • MongoDB
  • Express
  • Angular
  • Node

Development

Installing Dependencies

From within the root directory:

sudo npm install -g bower
npm install
bower install

Viewing the project

From the command line: mongod

In a separate terminal tab/window: nodemon index.js

In the browser: Navigate to : localhost:8000

(To view the database, in another terminal tab/window, type: mongo)

Running tests

Following all steps in "Viewing the project" then:

Front-end tests: (from the project root directory in a separate tab on the command line) gulp karma

Back-end tests: (from the project root directory in a separate tab on the command line) gulp mocha OR npm test

Roadmap

View the project roadmap here

Known Bugs

-At times, the landing page image does not properly load and user only sees a white background (Possibly related to index/backgroundController file test) -The deployed heroku version works, but only works on chrome(Maybe because of lack of Angular.js support? Unknown actual cause)

Avenues to explore

  • The server should make sure that the request process is authorized before adding a presentation

  • Lack of public feedback form control --Refresh on feedback form adds data again

  • Make the feedback form customizable

  • Enable user password change functionality

  • Server should make sure that the request process is authorized before adding a presentation

  • Shorten anonymous feedback form link url

  • Please see our task backlog here for more information

Contributing

See CONTRIBUTING.md for contribution guidelines.

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 74.2%
  • HTML 14.9%
  • CSS 10.9%