Used to get entries from the Oxford Learner's Dictionaries API.
This project enables the retrieval of entries from the Oxford Learner's Dictionaries API.
Make sure you have Node.js and npm installed on your machine. You can download them from nodejs.org.
To run this project locally, follow these steps:
- Clone the repository:
git clone https://github.com/Karl-Horning/oxford-learners-dictionaries-api.git
- Navigate to the project directory:
cd oxford-learners-dictionaries-api
- Install dependencies:
npm install
- Obtain an API key from the Oxford Learner's Dictionaries API by contacting Jeanna Occhiogrosso.
- Create an
.env
file in the root folder to securely store your API key and define the API's base URL:touch .env echo 'API_KEY=your_api_key' >> .env echo 'BASE_URL=https://www.oxfordlearnersdictionaries.com/api/v1/dictionaries/english/' >> .env
- Run the application:
npm start
- The generated HTML file will be located at
src/.temp/output.html
.
If you encounter any issues during installation or execution, please check the following:
- Ensure your API key is correctly configured in the .env file.
- Confirm that Node.js and npm are properly installed on your machine.
Contributions are welcome! Please follow these guidelines:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and ensure that the project still works.
- Create a pull request with a clear description of your changes.
This project is licensed under the MIT License.