Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/silent-watcher/dictionary
👻 This is a dictionary web application that allows users to search for word definitions. Leave a star before you leave ⭐
https://github.com/silent-watcher/dictionary
api-rest css dictionary dictionary-api dictionary-application dictionaryapi html-css-javascript html5 javascript kursorjs pwa-apps vite vite-pwa vitejs yarn
Last synced: about 1 month ago
JSON representation
👻 This is a dictionary web application that allows users to search for word definitions. Leave a star before you leave ⭐
- Host: GitHub
- URL: https://github.com/silent-watcher/dictionary
- Owner: Silent-Watcher
- License: mit
- Created: 2023-03-27T13:17:53.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-08T14:02:23.000Z (over 1 year ago)
- Last Synced: 2024-12-03T00:06:58.663Z (about 2 months ago)
- Topics: api-rest, css, dictionary, dictionary-api, dictionary-application, dictionaryapi, html-css-javascript, html5, javascript, kursorjs, pwa-apps, vite, vite-pwa, vitejs, yarn
- Language: JavaScript
- Homepage: https://silent-watcher.github.io/dictionary/
- Size: 837 KB
- Stars: 18
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Dictionary Web Application
This is a dictionary web application that allows users to search for word definitions. The application is built using HTML, CSS, and JavaScript, and utilizes the Vite bundler and Yarn as the package manager. The application is hosted on Netlify.
## Table of Contents
- [Features](https://github.com/Silent-Watcher/dictionary#features)
- [demo](https://github.com/Silent-Watcher/dictionary#demo)
- [preview](https://github.com/Silent-Watcher/dictionary#preview)
- [Prerequisites](https://github.com/Silent-Watcher/dictionary#Prerequisites)
- [Installation](https://github.com/Silent-Watcher/dictionary#Installation)
- [usage](https://github.com/Silent-Watcher/dictionary#usage)
- [Deployment](https://github.com/Silent-Watcher/dictionary#deployment)
- [Acknowledgements](https://github.com/Silent-Watcher/dictionary#Acknowledgements)
- [Feedback](https://github.com/Silent-Watcher/dictionary#Feedback)
- [License](https://github.com/Silent-Watcher/dictionary#License)
## Features
- User-friendly interface for searching word definitions.
- Quick and responsive search results.
- Intuitive navigation for browsing multiple definitions.
- Clean and modern design.
- Fully responsive on all devices.
## Demo
### netlify
https://dictionary-app-dev.netlify.app/
### GitHub pages
https://silent-watcher.github.io/dictionary/
[](https://stackblitz.com/github/Silent-Watcher/dictionary)
## Preview
## Prerequisites
In order to run this project, you will need to have the following installed on your computer:
- nodejs
- yarn | npm
## Installation
To install the application, follow these steps:
1. Clone the repository to your local machine:
```bash
git clone https://github.com/Silent-Watcher/dictionary
```
2. Navigate to the project directory in your terminal.
```bash
cd dictionary
```
3. Run `yarn` to install the necessary packages.
```bash
yarn
```
## usage
To start the application, run `yarn dev`. This will start the application on `http://localhost:5173`.
```bash
yarn dev
```
## Deployment
To deploy the application, follow these steps:
1. Create an account on Netlify.
2. Create a new site in Netlify.
3. Link the site to your GitHub repository.
4. Set the build command to `yarn build`.
5. Set the publish directory to `dist`.
6. Deploy the site.
## Acknowledgements
- [The build tool and development server.](https://vitejs.dev/)
- [ The API used in the project.](https://dictionaryapi.dev/)
- [The package manager used in the project.](https://yarnpkg.com/)
## Feedback
If you have any feedback, please reach out to us at [email protected]
## License
[MIT](https://choosealicense.com/licenses/mit/)
This project is licensed under the MIT License. See the LICENSE file for details.
