THE CODE DICTATOR - by The Table

Created: Tuesday, March 27th, 2018

Welcome to The Code Dictator!

The Code Dictator (brought to you by The Table) is a powerful speech-to-code web application that makes creating your HTML pages a breeze by simply using your voice. The Code Dictator uses Mozilla's Web Speech API to recognize a user's voice and create HTML elements that are requested. Using Bing Spell Check API, we also verify that your spelling is correct to minimize any problems with the Dictator understanding your speech. After creating your elements and dragging them to your element tree, we have also integrated with the W3C Markup Validation Service to make sure your HTML is syntactically sound.

Note: The Code Dictator currently only works on Google Chrome.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

* This is a web page exercise.  As such, you're welcome to download a copy and run it locally for review purposes.  

* Otherwise, you can view the output at: https://github.com/Geoff-Goodwin-Dev/TheTable-TheCodeDictator

Prerequisites

These are things you need to install the software and how to install them:

Any modern web browser should be able to open this static website

Installing

These are a set of step-by-step series of examples that tell you have to get a development env running:

Not Applicable

Running the unit-level tests

These are the details of how to run the automated tests for this system:

Not Applicable

End-to-end tests

These are the details of what these tests test and why:

Not Applicable

And coding style tests

This is where you will find details outlining the approach and coding style in terms of what these tests test and why

Not Applicable

Deployment

Additional notes about how to deploy this on a live system can be found here:

Not Applicable: This is a static website for educational purposes and therefore is suggested not to be deployed outside of its current location on Github

Built With

Webstorm (Version: 2017.3.4) - Generation of HTML, CSS, and JavaScript

Contributing

Thomas Yeager - Co-Author
Alex Gonzalez - Co-Author
Geoff Goodwin - Co-Author

Versioning

version 1.0 - Creation of file structure and project initialization

Authors

Thomas Yeager - Initial work - gamejock1
Alex Gonzalez - Initial work - agonz519
Geoff Goodwin - Initial work - Geoff-Goodwin-Dev

Licenses

The Code Dictator uses the Code Mirror Library and is shared under the following license:

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

===============================================================================

The Code Dictator uses W3C's Markup Validation Service and is shared under the following license:

This work is being provided by the copyright holders under the following license.

License By obtaining and/or copying this work, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions.

Permission to copy, modify, and distribute this work, with or without modification, for any purpose and without fee or royalty is hereby granted, provided that you include the following on ALL copies of the work or portions thereof, including modifications:

The full text of this NOTICE in a location viewable to users of the redistributed or derivative work. Any pre-existing intellectual property disclaimers, notices, or terms and conditions. If none exist, the W3C Software and Document Short Notice should be included. Notice of any changes or modifications, through a copyright statement on the new code or document such as "This software or document includes material copied from or derived from [title and URI of the W3C document]. Copyright © [YEAR] W3C® (MIT, ERCIM, Keio, Beihang)." Disclaimers THIS WORK IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENT WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.

COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENT.

The name and trademarks of copyright holders may NOT be used in advertising or publicity pertaining to the work without specific, written prior permission. Title to copyright in this work will at all times remain with copyright holders.

===============================================================================

Acknowledgments

Appreciation to PurpleBooth for initial Readme-Template
The Code Dictator uses Microsoft's Bing Spell Check API to verify user typed submissions are spelt correctly.
The Code Dictator uses Mozilla's Web Speech API to recognize a user's voice and create HTML elements that are requested.