Connect your credentials provided in the official API documentation when you're registered to show your favorite GIF's, also protecting secret keys and sensitive information with environment variables.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy on a live system and clone the repository.
- (Option 1): Clone the repository with link "https"
git clone https://github.com/escummy/giphy-api.git- (Option 2): Clone the repository with link "SSH"
git clone git@github.com:escummy/giphy-api.git- (Option 3): Download the file.zip to your desktop
To continue, you need to have installed: Node
(Check in your terminal bash)
node --versionElse, Install nodejs from the official site 'version LTS' (Recommended)
[English] - https://nodejs.org/en/ (or) [Spanish] - https://nodejs.org/es/
Include in the root of your project the .env file with the credentials provided by the API official docuemntation, then replace in the proper file your real API key with ${REACT_APP_API_KEY} to not expose sensitive data.
REACT_APP_API_KEY=your_api_keyNOTE: Include this .env file in the .gitignore to be excluded by the repository.
Install the necessary dependencies and devDependencies from any package.json
npm installIn the project directory, you can run:
npm startRuns the app in the development mode.
Open http://localhost:3000 to view it in the browser.The page will reload if you make edits.
You will also see any lint errors in the console.
Start checking tests with the following command, which will open a debug console and UI interface in the browser to help with the testing process.
npm testBuilds the app for production to the build or dist folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
npm run buildYour app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can't go back!
If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
npm run ejectInstead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except
ejectwill still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
Recomendations:
- Check this visual studio code settings.json
- To install the necessary extensions, add extension 'missing extensions' to your vscode
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
Repositories use SemVer for versioning, three-digit numbering technique based patter of Major, Minor and Patch fixes, see the release tags for more details about version available.
Contributions are always welcome.
See CONTRIBUTING for ways to get started, you can colaborate addings features to improve the repository, you can feel free to suggest anything or help solving issues via pull request.
Please adhere to this project CODE_OF_CONDUCT, examples of behavior that contributes to a positive environment for our community and adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
[Author]: Gonzalo Cugiani (Amsterdam, North Holland, Netherlands)
A licensor may grant a license under intellectual property laws to authorize a use (such as copying software or using a patented invention) to a licensee, sparing the licensee from a claim of infringement brought by the licensor.
License used for this repository [MIT License]
. . .
This README file was updated
Last refresh: Wednesday, 10 July, 18:08 CET