An SMS Education Platform.
Welcome to the Text-ED project! Thank you for stopping by.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Text-ED requires Python 3.4 or later. If you are running an older version of Python, download the latest version here.
The following installation instructions assume a familiarity running commands in a Terminal. If you are unfamiliar with running commands on a terminal, there are two conventions to keep in mind when following the below instructions: (1) The $ sign is a convention indicating that the following command is a command to be run in Terminal; do not include it when actually running your commands. (2) Square brackets are used to indicate variable information that you should include without the square brackets. For example, if a command says, $ cd [project_folder], the real command would look something like $ cd Text-ED depending on the name of the project folder and your current location in your computer's file tree.
- Download the git repository to your computer:
$ git clone [project_url]
- Install libraries
Navigate to the newly-created project folder in your Terminal, and run the following command to install the necessary pip dependencies:
$ pip install -r requirements.txt
- Run the server on your machine
Use the following command to run the server in test mode on your machine:
$ python3 serverside.py test
After running this command, you should see the following prompt appear in your terminal:
[SMS] >>
At which point you are running the serverside software in test mode. Test mode enables you to locally run the serverside software to test commands without running it remotely on a server linked to a Twilio account. To exit this prompt (and return to your normal terminal), you can type either quit() or exit() at the [SMS] >> prompt.
[comment]: <> ### Orientation
[comment]: <> TODO: instructions on getting setup with Twilio, running this using their platform, and ngrok.
If you wish to contribute to this project, we would welcome your support!
To offer feedback and ideas, please open an issue in the GitHub repository, or send me an email.
Current active developers: