sethgonzales / power-plant

(Application Name)

(Brief Description of Application)

By Seth Gonzales

Technologies Used

• HTML
• CSS
• JavaScript
• Node v16.13.1
• npm v8.1.2

Description

Setup/Installation Requirements

• • Navigate to the __________ repository on GitHub.
• Clone the repository from GitHub.
• Create the clone using $ git clone https://github.com/sethgonzales/file-name in terminal.
• Open the repository and create a .env file in the root directory.
• Get API Key from [website] (https:). If needed, create an account follow the instructions here: [website] (https:).
• Add the API Key into the .env file as "API_KEY=_". Double check if it is in the .gitignore.
• In terminal...
  • Run $ npm install from the root directory to install all packages.
  • Build the project using webpack with $ npm run build.
  • Lint JavaScript files with $ npm run lint.
  • Run tests in Jest with $ npm run test.
  • Deploy a development server with $ npm run start.
  • Deploy the site on GitHub Pages with $ npm run deploy

Known Bugs

• Any known issues
• should go here

License

MIT License

Copyright (c) 2023 Seth Gonzales

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.

Contact Information

If you run into any issues, or would like to contribute to our code, please email: [e-mail].