README.md

Textbook

A web platform for teachers to communicate with parents via SMS messaging in an easy and organized way.

Table of Contents

• Examples
• Installation
• Usage
• Roadmap
• Contributors
• License

Examples

Demo

See a live version of the app here.

Screenshot

Above: An example of a teacher interacting with a parent using the app

Installation

1. Clone the repository

   git clone https://github.com/andrewmiller0/textbook.git

2. Install dependencies

   npm install    # installs node packages
   bower install  # installs bower dependencies

3. Sign up for a free Twilio trial account

4. Create a local.env.js in /server/config/environment and include your TWILIO_ACCOUNT_SID, TWILIO_AUTH_TOKEN, and phoneNumber

Note: If you encounter errors in the installation process for npm, it is recommended that you try running the install command with sudo

Usage

1. Make sure that you have MongoDB installed correctly and running on your machine

   mongod

2. Serve the application with grunt

   grunt serve

3. Enjoy!

Testing

To run the test suite, run the following command:

grunt test

Roadmap

Features

• More unit tests for frontend and backend
• Classroom enrollment via SMS messaging
• Ability to schedule messages
• Message templating system
• Native mobile app for iOS and Android

Known bugs

• Spreadsheet upload does not account for empty cells or corrupted files
• Edge case with same contact being on mulitple students for one teacher not met yet

Contributors

• Andrew Miller - LinkedIn | GitHub
• Melissa Moy - LinkedIn | GitHub
• Chuck Pierce - LinkedIn | GitHub

License

This project is licensed under the terms of the MIT license