https://github.com/jperals/simple-dict
Simple, yaml-based term-definition dictionary
https://github.com/jperals/simple-dict
dictionary yaml
Last synced: about 2 months ago
JSON representation
Simple, yaml-based term-definition dictionary
- Host: GitHub
- URL: https://github.com/jperals/simple-dict
- Owner: jperals
- Created: 2017-07-28T11:00:35.000Z (almost 9 years ago)
- Default Branch: develop
- Last Pushed: 2018-10-23T21:34:01.000Z (over 7 years ago)
- Last Synced: 2025-03-27T10:21:13.056Z (about 1 year ago)
- Topics: dictionary, yaml
- Language: JavaScript
- Size: 530 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# simple-dict
Simple, yaml-based term-definition dictionary.
This is a micro-project I set up for myself just to show off my daughter's first ca. 100 words.
I set up a nice workflow based on Gulp, Express and React in order to make it simple to add terms and to edit the codebase as well.
## Setup
To install all dependencies:
```
npm install
```
### Development
Just run
```
gulp serve
```
then visit e.g. `localhost:3000/laia-ca`, where the `laia-ca` refers to the dictionary in `data/laia-ca.yaml`. Both the server and the browser will reload automatically on changes.
### Genereate a build
Just run
```
gulp build
```
which will generate a static build under `static` for all existing dictionaries. You can then publish to any static hosting provider, like Github Pages.
### Edit and create new dictionaries
Dictionaries are written in yaml and live under `data`. You can take the existing one as a reference.