• LINK

• VS Code Software
• Git
• Github
• Google Chrome Browser
• HTML
• CSS
• Markdown
• Bootstrap
• JavaScript
• jQuery

This is an application that checks whether a poem is in fact a haiku. A haiku is a poem that consists of three lines. The first has five syllables, the second has seven, and the third has five.

Cloning

1. In order to utilize this page on your local machine, you will need to clone a copy of this repository using the "$ git clone {url}" command in your coding terminal.
2. Navigate to your desired directory in your command terminal and run "$ git clone LINK"
3. Should you wish to edit the code you cloned, you will need coding software. VS Code is an example of a free code editor, which can be downloaded at https://code.visualstudio.com/.
4. Once your coding software is installed, open the folder of the cloned repository, which will contain the HTML files, the bootstrap.css framework, any images, audio, as well separate individual stylesheets for each HTML file.
5. To view the finished site locally, simply navigate to the folder/directory which you cloned the project, and open the index.html file in your browser.

Downloading

1. In your browser, navigate to LINK, and click the green "Code" button, which will provide a drop down menu. Click on "Download ZIP" at the bottom of the menu, and save it to your desired location.

2. Once downloaded, unzip and extract the files.

3. Follow the steps above to view, edit, and open the files as needed.

API Key and Private .env file

1. To run this project, will need to sign up for an account at https://www.exchangerate-api.com/

2. Continue to their sign-up page at https://app.exchangerate-api.com/sign-up. You can choose a plan that works for you, but they have a free plan that allows up to 1,500 API calls a month

3. Add an PRIVATE .env file to your top most directory.

4. Save the API key provided after sign-up by typing the following in your .env following: API_KEY=INSERT YOUR API KEY HERE

5. Ensure that you have added .env to your .gitignore file BEFORE PROCEEDING

Build the Environment and Run the Project

1. You will need to run the command "npm install" in your terminal to download the appropriate node modules.

2. You will then need to build the project using the command "npm run build".

3. Once built, you can open dist/index.html in your browser.

4. To run a server view of the project, you can type the command "npm start" to witness and inspect any changes you wish to make in real time.

• No Known Bugs.

This project is licensed under the MIT License. Copyright (C) 2022 Ryan Ashby. All Rights Reserved.

MIT License

Copyright (c) 2022 Ryan Ashby.

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.

Return to Top