- List all
- the major technologies
- you used in your project
- here
-
This is a great place
-
to list setup instructions
-
in a simple
-
easy-to-understand
-
format
-
Desktop/Stand-alone Setup:
-
Clone this repository
-
Sign up for an account with GIPHY at the GIPHY developer site
-
Get an API key by clicking "Create an App".
-
Create a file '.env' and place it in the root folder of the downloaded repository.
-
Include API_KEY={your API key} in the text of the .env file.
-
Navigate to the root folder of this downloaded repo in your terminal.
-
Run npm install.
-
Run npm run start to open the page in your default browser.
-
Worth noting for non-Mac users: in the package.json "scripts" for lint: line 9's has an extra " ' " surrounding src:... which allows es lint to access files recursively "lint": "'eslint src/*.js'",
-
Any known issues
-
Please reach out with any questions or concerns at: [email protected]
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) [2023] [Eliot Gronstal]