(Application Name)

(Brief Description of Application)

By (Your Name Here)

Technologies Used

• HTML
• CSS
• JavaScript
• NodeJS v16.13.1
• npm v8.1.2
• APIs - 3rd party

Description

Setup/Installation Requirements

Generate an API key for OpenWeather:

• Go to https://openweathermap.org/ using your internet browser.
• Sign up for an account, and sign in.
• Once you are signed in, click on the API keys tab.
• Click "Generate" button to generate an API key. Name it as you wish. It is named "Default" by default. Keep your API key handy -- copied, ready to paste.

Cloning the Repository:

• Clone the repository from the GitHub link: (add link here)

• Navigate to the project's root directory.

• In your code editor, navigate to your project root directory. Create a file named ".env".

• Open up ".env" and save in the first line: API_KEY=[your api key here] omitting the square brackets []

• In your terminal, run $ npm install from the root directory to install all packages.

• Build the project using webpack using $ npm run build

• Lint JavaScript files with $ npm run lint

• Run tests using Jest with $ npm run test

• Start the development server in your browser with $ npm run start

Known Bugs

• Any known issues
• should go here

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.

Copyright (c) year name