monaqvi / idioma

An app that connects language learners

iDioma

An app that connects language learners

1. Usage
2. Requirements
3. Tech Stack
4. Schema
5. Development
   1. Setting up MySQL database
   2. Adding MySQL password
   3. Adding Facebook OAuth configuration
   4. Installing Dependencies
   5. Starting MySQL server
   6. Starting server locally
6. Team
7. Current Build Health
8. Roadmap

Usage

See the app in action here.

Requirements

Node v5.8
Webpack
MySQL

Tech Stack

• React and Redux
• Node and Express
• Sequelize ORM and MySQL

Schema

Development

Setting up MySQL database

(If you don't have Homebrew installed, go to http://brew.sh/ to install Homebrew.)

brew install mysql
mysql -u root
CREATE DATABASE idioma

Adding MySQL password

Navigate to server/db, add a config.js file and export your mysql root user password as a string. This file is git ignored. Format: module.exports = 'password';

Adding Facebook OAuth configuration

Navigate to server/auth, add a config.js file and export your facebook OAuth client ID and secret in an object. This file is git ignored. Format: module.exports = {ID: 'id', SECRET: 'secret'};

Adding Twilio credentials

Navigate to root directory, add a .env file and add Twilio Account SID, Video Configuration SID, API Key, and API Secret. Reference this repo (https://github.com/TwilioDevEd/video-quickstart-node) for links to generate these credentials if you do not already have them. This file is git ignored. Format:

TWILIO_ACCOUNT_SID=
TWILIO_API_KEY=
TWILIO_API_SECRET=
TWILIO_CONFIGURATION_SID=

Installing Dependencies

From within the root directory:

brew install node
npm install -g webpack
npm install

Starting MySQL server

mysql.server start

Starting server locally

npm start

Team

• Product Owners: Muhammad Naqvi, Reina Mei
• Scrum Master: Ashwin Ravi

Current Build Health

View the build history

Roadmap

View the project roadmap here