Skip to content

Latest commit

 

History

History
228 lines (160 loc) · 8.03 KB

README.md

File metadata and controls

228 lines (160 loc) · 8.03 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Dictionary

A React app that will display the definition and example usage of any word typed by the user. This app uses the Merriam Webster Dictionary API.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

(back to top)

Built With

  • React
  • fontawesome

(back to top)

Getting Started

Prerequisites

Below is a list of things you need to use the project and how to install them.

  • None

Installation

  • Clone the repo

    git clone https://github.com/KaraboMolemane/dictionary-react.git

  • Run Back end

    • N/A

  • Run Front end

    • Install NPM packages for the front end 
       npm install
    • Once the installtion is done, you can start the frontend by typing the following: 
      npm start
    • The front end runs on http://localhost:3000/ and will automatically open on your default browser.
    • The project uses nodemon to automatically reload every time a change is made and saved.

(back to top)

Usage

Once the project is opened in your browser. You will be presented with the home screen where you can input a phrase to search for. Enter the phrase and hit "Get definition" to get the results.

Logo

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • allow user to generate and use their own API Key

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

N/A

(back to top)

Contact

Karabo Molemane - https://www.linkedin.com/in/karabo-molemane/

Project Link: https://github.com/KaraboMolemane/dictionary-react

(back to top)

Acknowledgments

(back to top)