Skip to content

Latest commit

 

History

History
31 lines (16 loc) · 1.76 KB

README.md

File metadata and controls

31 lines (16 loc) · 1.76 KB

Haiku Builder: The Front End

Demo

This JavaScript Single Page Application was built to help poetry enthusiasts create haikus with greater ease! Through the incorporation of the Datamuse API, poets can enter any string of words and easily find an automated syllable count for each line in their haiku. Haiku Builder follows the convention of a three line haiku with the consecutive syllable structure 5, 7, 5.

Installation

Start crafting your own haikus! To begin, fork this repository and clone it to your hard drive. CD into the folder and if you're in your terminal, enter open index.html to get your app running. Or in your editor, right click on index.html, click on copy full path, and paste in a browser address bar.

In order to persist your poems, you will need fork and clone the Ruby on Rails backend located here.

Structure

The index.html file hold the structure of the app. An src folder contains the index.js file which holds the JavaScript and DOM manipulation logic.

Using the Application

Haiku Builder

You can type any combination of words and a syllable count will appear in the grey box at the end of each input field. If you would like to save the haiku for later, you will have to identify yourself as either an existing or new user.

User Login

In order to save your haiku, you have to identify yourself as an existing user or create an account. If this is your first time using this app, enter your desired username into the "Create a user" input field and submit. If you are a returning user, enter your username.