Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gbv/cocoda-locale-editor

coli-conc web-application

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/gbv/cocoda-locale-editor
Owner: gbv
License: mit
Created: 2018-12-04T11:00:41.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2023-01-10T03:13:50.000Z (almost 2 years ago)
Last Synced: 2024-04-14T12:58:39.121Z (8 months ago)
Topics: coli-conc, web-application
Language: Vue
Homepage: https://gbv.github.io/cocoda-locale-editor/
Size: 3.9 MB
Stars: 0
Watchers: 4
Forks: 0
Open Issues: 10
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# cocoda-locale-editor
An editor for single file locale files in JSON format, e.g.

```json
{
"en": {
"hello": "Hello"
},
"de": {
"hello": "Hallo"
}
}
```

Currently hosted on GitHub Pages at https://gbv.github.io/cocoda-locale-editor/.

Work in progress.

## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Starting from scratch](#starting-from-scratch)
- [Using an existing file](#using-an-existing-file)
- [Maintainers](#maintainers)
- [Publish](#publish)
- [Contribute](#contribute)
- [License](#license)

## Install
```sh
npm ci
# Run dev server on port 8093
npm run dev
# Build the application (into folder dist/)
npm run build
```

## Usage

### Starting from scratch

First, click the "Reset" button to remove the example keys and languages. Add the languages you want to have in your file (e.g. "en" and "de"). When adding keys (at the bottom of the page), note that the chosen language in the dropdown will be the one where the key will be first created (with an empty string as a value). You can add nested keys by using the dot notation, for example "general.title". Note that you won't be able to add nested keys under an existing key (because it was already created as a string).

When you are finished, click the "Download" button at the top of the page to download the .json file with your locale.

### Using an existing file

There are two options for editing an existing file:
1. Uploading the file from disk.
2. Loading the file from an URL.

The latter will also add a URL parameter to the application so that the file can be loaded automatically. Example: https://gbv.github.io/cocoda-locale-editor/?fromUrl=https%3A%2F%2Fraw.githubusercontent.com%2Fgbv%2Fcocoda%2Fdev%2Fconfig%2Flocale.json

You can add languages with the field above the table, or add keys with the field below the table. When you are finished editing, save the file by clicking the "Download" button at the top. You can then commit the file into your repository.

## Maintainers
- [@stefandesu](https://github.com/stefandesu)

## Publish
Currently, the `master` branch is directly deployed to GitHub Pages.

## Contribute
Please use [GitHub issues](https://github.com/gbv/cocoda-locale-editor/issues) for bug reports, feature requests or questions.

PRs accepted.

Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.