Obento

Open Source Flashcard App with Voice Interactions

Team

• Eric Chen
• David Zou
• Wilton Chew
• Patrick Xie

Table of Contents

1. Team
2. Usage
3. Requirements
4. Development
   1. Installing Dependencies
   2. Roadmap
5. Style Guide
6. Contributing
7. Press Release

Installing Dependencies

Install Main Server From within the root directory:

npm install

Install Voice Server

Follow the instructions on: https://cloud.google.com/speech/docs/getting-started

Export GOOGLE_APPLICATION_CREDENTIALS=/~~your path here~~/googleSpeechKey.json

npm run voice:install

Usage

Install dependencies, then run the following: Start main server

npm run create:db
npm run build:watch
npm start
npm run seed

Start voice server

npm run voice

Go to localhost:8000 to run the app.

Roadmap

View the project roadmap Trello

Style Guide

See STYLE-GUIDE.md for style guide information.

Contributing

See CONTRIBUTING.md for contribution guidelines.

Press Release

See PRESS-RELEASE.md for more information about Obento.

Packages

• @google-cloud/speech ^0.8.0
• axios ^0.15.3
• babel-polyfill ^6.23.0
• bcryptjs ^2.4.3
• binaryjs ^0.2.1
• bluebird ^3.5.0
• body-parser ^1.17.1
• classnames ^2.2.5
• connect-flash ^0.1.1
• connect-history-api-fallback ^1.3.0
• cookie-parser ^1.4.3
• draft-js ^0.10.0
• elasticsearch ^13.0.0-rc2
• eslint ^3.19.0
• express ^4.15.2
• express-session ^1.15.2
• http-aws-es ^1.1.3
• linear16 ^1.0.1
• lodash ^4.17.4
• mdbootstrap ^4.3.1
• morgan ^1.8.1
• mysql ^2.13.0
• node-record-lpcm16 ^0.2.0
• passport ^0.3.2
• path ^0.12.7
• react ^15.4.2
• react-bootstrap ^0.30.8
• react-card ^1.0.4
• react-deck ^2.0.2
• react-dom ^15.4.2
• react-flipcard ^0.2.1
• react-redux ^5.0.3
• react-router ^3.0.2
• react-router-dom ^4.0.0
• react-router-redux ^5.0.0-alpha.5
• react-rte ^0.11.0
• react-rte-image ^0.11.1
• react-slick ^0.14.7
• react-swipeable ^3.9.2
• redux ^3.6.0
• redux-logger ^3.0.1
• redux-promise ^0.5.3
• redux-thunk ^2.2.0
• sequelize ^3.30.4
• slick-carousel ^1.6.0
• twilio ^2.11.1
• wav ^1.0.1

Development

• babel-core ^6.24.0
• babel-loader ^6.4.1
• babel-plugin-transform-object-rest-spread ^6.23.0
• babel-preset-env ^1.2.2
• babel-preset-es2015 ^6.24.0
• babel-preset-react ^6.23.0
• babel-preset-stage-0 ^6.22.0
• chai ^3.2.0
• chai-http ^1.0.0
• css-loader ^0.26.4
• eslint ^3.19.0
• eslint-config-airbnb ^14.1.0
• eslint-plugin-import ^2.2.0
• eslint-plugin-jsx-a11y ^4.0.0
• eslint-plugin-react ^6.10.3
• jest ^19.0.2
• mocha ^3.2.0
• nodemon ^1.11.0
• react-hot-loader ^3.0.0-beta.6
• react-test-render ^1.0.3
• sinon ^2.1.0
• style-loader ^0.13.2
• webpack ^2.3.2
• webpack-dev-server ^2.4.2

License

MIT