Skip to content

omarkarake/dictionary-app

Repository files navigation

My React Dictionary App

This is a React-based dictionary application that allows users to search for word definitions. The application is deployed and hosted on Netlify.

Project URL

The project is live at: My React Dictionary App

Features

  • Search for word definitions.
  • Displays phonetics and audio pronunciation.
  • Shows parts of speech, meanings, examples, and synonyms.
  • Responsive design for various screen sizes.
  • Supports dark mode based on user preference or system settings.

Technologies Used

  • React
  • TypeScript
  • Tailwind CSS
  • Netlify (for deployment)

Getting Started

Prerequisites

Make sure you have the following installed on your machine:

  • Node.js (v12 or higher)
  • npm (v6 or higher) or yarn

Installation

  1. Clone the repository:
    git clone https://github.com/omarkarake/dictionary-app/
    cd your-repo
    Install the dependencies:
    bash

npm install

or

yarn install

For Running the Project Locally Start the development server:

npm start

or

yarn start

Open your browser and navigate to http://localhost:3000 to see the app running.

Building the Project To create a production build of the project, run:

npm run build

or

yarn build

This will generate a build directory with the optimized production build.

##Deployment The project is already deployed on Netlify. To redeploy or update your deployment, follow these steps:

##Configuration Changing Fonts and Dark Mode The app supports dynamic font changes and dark mode. These can be toggled using the provided UI in the app's header.

##Contributing If you'd like to contribute to this project, please fork the repository and use a feature branch. Pull requests are welcome.

##Fork the repository.

Create a feature branch: git checkout -b my-new-feature Commit your changes: git commit -am 'Add some feature' Push to the branch: git push origin my-new-feature Create a new Pull Request.

##Acknowledgements React Tailwind CSS Netlify

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published