This is a simple dictionary app built with React that allows users to search for definitions of words and view related images. It uses the Pexel API to fetch images and the Dictionary API to fetch definitions.
- Hosted on Netlify.
- Search function: Allows users to search for definitions of words.
- Definition display: Displays the definition of a word when it is searched for.
- Image display: Displays a related image for a word when it is searched for.
- Pronunciation: Provides audio pronunciation for words.
- To get started with this app, follow these steps:
- Clone or download the repository.
- Navigate to the project directory and install the dependencies by running npm install.
- Create a file called .env in the root directory of the project and add your API keys for the Pexel API and Dictionary API. Your .env file should look like this:
PEXEL_API_KEY=your_api_key
DICTIONARY_API_KEY=your_api_key
- Start the development server by running npm start. The app should open in your default browser.
- The app may not display results for all words, as the Dictionary API only covers a limited number of words.
- The app may not display images for all words, as the Pexel API may not have relevant images for all words.
- If you would like to contribute to this project by forking it, you can follow these steps:
- Go to the project's GitHub repository.
- Click the "Fork" button in the top right corner of the page. This will create a copy of the repository in your own GitHub account.
- Clone the forked repository to your local machine using the git clone command and the URL of the repository.
- Create a new branch on your local machine using the git branch command. This is where you will make your changes.
- Checkout the new branch using the git checkout command.
- Make your changes to the code on this branch.
- Test your changes to make sure they are working as intended.
- Commit your changes to the branch using the git commit command.
- Push your changes to your forked repository using the git push command.
- Go to the original repository on GitHub and create a new pull request. This will allow the maintainers of the original repository to review your changes and potentially merge them into the main codebase.
- It's important to keep in mind that the maintainers of the original repository have the final say on whether or not to merge your changes. They may request that you make additional changes or discuss the changes with you before deciding to merge them.
- To report a bug in the dictionary app, you can follow these steps:
- Identify the problem: First, you need to determine what the issue is and how it is affecting your use of the app. Be specific and include as much detail as possible. For example, "When I search for the word 'apple', the app crashes" or "The app is not displaying any images for any words I search for."
- Reproduce the issue: Try to reproduce the problem to confirm that it is a bug and not just a one-time occurrence. This can also help you gather more information about the issue.
- Collect information about the bug: In order to help the fix the bug, you will need to provide as much information as possible. This may include the the operating system you are using, any error messages or codes you received, and the steps you took to reproduce the bug. You should also note which API you were using (Pexel or Dictionary) and what word you searched for when the bug occurred.
- Create a bug report: There are several ways you can create a bug report, including using a bug tracking tool, creating a document or spreadsheet, or even just writing down the information in a note. Be sure to include all of the information you collected about the bug, as well as any suggestions you have for how the issue could be fixed.
- Submit the bug report: Once you have created your bug report, you can submit the report through a bug tracking tool by email.
By following these steps, you can help fix the bug and improve the app for all users.