{Application Name}

By E. Luckie ☀️

{Brief description of application}

Technologies Used

• HTML
• CSS
• JavaScript
• Markdown
• Git
• Jest
• Babel
• ESLint
• npm
• node.js
• webpack
• DotEnv

Description

{This is a detailed description of your application. Give as much detail as needed to explain what the application does as well as any other information you want users or other developers to have.}

Click here to view the live version of this ______ webpage.

Setup/Installation Requirements

// UPDATE NAME IN PACKAGE & PACKAGE-LOCK.JSON & WEBPACK.CONFIG

• [SIGN UP FOR AN ACCOUNT TO GET AN API KEY]
• Clone this repository to your desktop
• Navigate to the top level of this directory in your computer's terminal
• create a file named ".env" in the top level of this directory
• In the text of the .env file, include "API_KEY={your API key}" where {your API key} is replaced with the actual numbers of your API key
• Navigate to the top level of this directory in your computer's terminal
• Run the command "$ npm install" to install the necessary packages
• Run the command "$ npm run start" in your terminal to build the webpage. This will also open a live server in your browser so that you will be able to see any changes you make to the code in real time.

{Leave nothing to chance! You want it to be easy for potential users, employers and collaborators to run your app. Do I need to run a server? How should I set up my databases? Is there other code this application depends on? We recommend deleting the project from your desktop, re-cloning the project from GitHub, and writing down all the steps necessary to get the project working again.}

Known Bugs

• Any known issues
• should go here

License

MIT License

Copyright (c) 2023 Luckie

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.