soops/EssayMaker

View on GitHub
README.md

Summary

Maintainability
Test Coverage
EssayMaker
==========
[![Code Climate](https://codeclimate.com/github/soops/EssayMaker/badges/gpa.svg)](https://codeclimate.com/github/soops/EssayMaker)
[![GitHub version](https://badge.fury.io/gh/soops%2FEssayMaker.svg)](https://badge.fury.io/gh/soops%2FEssayMaker)
[![Gitter](https://badges.gitter.im/soops/EssayMaker.svg)](https://gitter.im/soops/EssayMaker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![Donate to this project using PayPal. Every little bit helps!](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TUFL9KWZGXZE2)
[![Follow us on Twitter](https://img.shields.io/badge/twitter-%40getessaymaker-55acee.svg)](https://twitter.com/getessaymaker)

EssayMaker replaces clunky on-paper essay organizers by combining them with traditional word processors. It’s the essay writing tool you didn’t know that you wish existed.

Use it just like a word processor and export your essay when you’re ready to turn it in. EssayMaker handles the process of organizing and fixing up your essay so you can focus on one thing: writing. No clunky transfer process, just one button.

Features
--------
- Organize essays with ease and speed.
- Minimalist, no BS interface.
- Absolutely free with no ads or paywalls.
- Platform friendly: Works on everything from a laptop to a phone to a television.
- Faster and more organized than any other writing method.
- HTML and plaintext file export, (PDF and Markdown types coming soon) and if you aren’t able to use those, you can also copy the finished product to your clipboard.
- Markdown syntax is supported for output to HTML.
- Saving and loading support: start your essays and finish them another time.
- Preview your essay before it is finished with a simple toggle.
- Built in sentiment analyzer lets you know about the tone of your essay as you write it.

Installation
------------
EssayMaker runs in a web browser, but can also be downloaded for offline use. A zip file of the standalone version is included in every release. [Get the latest release on GitHub](https://github.com/soops/EssayMaker/releases/latest), or just go to [EssayMaker](http://getessaymaker.com/dist).

Development
------------

gulp and bower are required to be installed on your machine. Clone the
repository, install dependencies, and run `gulp setup`.

```bash
git clone https://github.com/soops/essaymaker.git

# cd into the directory and install dependencies
cd essaymaker && npm install && gulp setup

open index.html
```

Contribute
----------
- [Contribution guidelines](https://github.com/soops/EssayMaker/blob/master/CONTRIBUTING.md).
- [Issue tracker](https://github.com/soops/EssayMaker/issues).
- If you’re feeling like it, you can donate to my PayPal.

Support
-------
If you find something wrong with EssayMaker, or just want to suggest features, feel free to submit an issue on GitHub, chat with us on [Gitter](https://gitter.im/soops/EssayMaker), tweet us [@getessaymaker](http://twitter.com/getessaymaker), or send us an email: **getessaymaker at gmail dot com**

License
-------
This project is open source under the MIT license. All libraries used are subject to their own copyright. EssayMaker is (c) 2015 Ethan Arterberry.