Skip to content

Commit

Permalink
Merge branch 'release/1.0.0'
Browse files Browse the repository at this point in the history
* release/1.0.0:
  bump
  include live link
  include build:serve script
  Write README
  • Loading branch information
manuphatak committed May 24, 2016
2 parents 2c3ac07 + f01c292 commit c2ac251
Show file tree
Hide file tree
Showing 9 changed files with 61 additions and 3 deletions.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,63 @@
[![Build Status][travis-image]][travis-url]
[![Coverage Status][coverage-image]][coverage-url]

*Premier data collection & survey machine. An Angular & Loopback responsive survey app with a d3 graphical admin interface.*

More information @ https://manuphatak.com/portfolio/sumo-survey/

Live @ http://sumo-survey.manuphatak.com/

## Local Install

1. Create a MySQL user/database named `sumo-survey` with password `secret`

```sql
CREATE USER 'sumo-survey'@'localhost' IDENTIFIED BY 'secret';
CREATE DATABASE IF NOT EXISTS `sumo-survey`;
GRANT ALL PRIVILEGES ON
`sumo-survey`.* TO 'sumo-survey'@'localhost';
```
2. `npm install`
3. Run local dev server `npm run dev` OR serve a build `npm run build:serve`
4. http://localhost:5000 (dev) OR http://localhost:3000 (build:serve)
5. Login to admin interface with username: `admin@example.com` and password: `secret`

## Requirements
1. Create a web app written in Node.JS using an Express based framework, SequelizeJS, and MySQL.
1. Use NPM to declare all dependencies so that we can run it in a test environment.
1. The app should allow an admin to enter survey questions with multiple choice answers.
1. When a guest visits the app in a browser it should present a random survey question to the guest and allow them to answer.
1. Record answers and display the survey results in an admin interface.
1. Avoid showing a previously answered question to the same guest.
1. Make sure the UI is mobile browser friendly.
1. Provide a clear README with instructions on how to setup and run the app.
1. Create a github.com repository with the app that we can pull from and test.

## Known Bugs

* The ‘admin add survey’ form is buggy on Firefox. It’s submitting the entire form when you click to add a choice.
* The d3 frequency charts are not respecting the width of its container (on smaller screen sizes).

## Screenshots

![Home][screen-home]
![Survey][screen-survey]
![Fin][screen-fin]
![Login][screen-login]
![Admin Questions][screen-admin-questions]
![Admin Choices][screen-admin-choices]
![Admin Add][screen-admin-add]

[travis-image]: https://travis-ci.org/bionikspoon/sumo-survey.svg?branch=master
[travis-url]: https://travis-ci.org/bionikspoon/sumo-survey

[coverage-image]: https://coveralls.io/repos/github/bionikspoon/sumo-survey/badge.svg?branch=master
[coverage-url]: https://coveralls.io/github/bionikspoon/sumo-survey?branch=master

[screen-home]: docs/screenshots/10-home.png
[screen-survey]: docs/screenshots/20-survey.png
[screen-fin]: docs/screenshots/30-fin.png
[screen-login]: docs/screenshots/40-login.png
[screen-admin-questions]: docs/screenshots/50-admin-questions.png
[screen-admin-choices]: docs/screenshots/60-admin-choices.png
[screen-admin-add]: docs/screenshots/70-admin-add.png
Binary file added docs/screenshots/10-home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/20-survey.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/30-fin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/40-login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/50-admin-questions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/60-admin-choices.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/70-admin-add.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 6 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
{
"name": "sumo-survey",
"version": "0.0.0",
"version": "1.0.0",
"private": true,
"main": "server/server.js",
"scripts": {
"prestart": "npm run migrate",
"start": "slr .",
"dev": "gulp dev --debug",
"build": "gulp build",
"build:debug": "npm run build -- --debug",
"test": "karma start --debug",
"posttest": "nsp check",
"test:watch": "karma start --debug --auto-watch --no-single-run",
"coveralls": "[ -e ./coverage/lcov.txt ] && cat ./coverage/lcov.txt | coveralls || exit 1",
"migrate": "./bin/migrate",
"build": "gulp build",
"build:debug": "npm run build -- --debug",
"prebuild:serve": "npm run build",
"build:serve": "npm install strong-supervisor",
"postbuild:serve": "npm run start",
"preheroku-postbuild": "npm run build",
"heroku-postbuild": "npm install -g strong-supervisor",
"postheroku-postbuild": "npm prune --production"
Expand Down

0 comments on commit c2ac251

Please sign in to comment.