Skip to content

Latest commit

 

History

History
193 lines (138 loc) · 5.59 KB

README.md

File metadata and controls

193 lines (138 loc) · 5.59 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

The Dictionary

An English Dictionary supported by Free Dictionary API
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. Author
  5. License

About The Project

THE_DICTIONARY_SCREENSHOT

An English Dictionary supported by Free Dictionary API

Features

The current stills in development, so the next updates will come with following features:

  • Home view
  • Scroll Navigation
  • Hero Section
  • Credits Views
  • Footer
  • Color schema

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

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

To run this project on your local machine or deploy it to a server we need to use or have the following tools:

Run on Localhost

  1. Clone the repo

    git clone https://github.com/devCluna/the_dictionary

  2. Open a terminal of your choice, enter the root directory

  3. Create an .env file in the root directory inside this include the following info:

//.env file
VITE_APP_URI = https://dictionaryapi.dev/
  1. Install the dependencies
yarn
  1. finally run the scripts
yarn run dev

Contributing

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

  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

Author

Cristhian Luna

License

Distributed under the MIT License. See LICENSE for more information.