Einakter

Database of German one-act plays.

Development

This project was bootstrapped with Create React App. You can learn more in the Create React App documentation.

Quick start

After installing nodejs and yarn you can start the Einakter database by running the following commands:

git clone git@github.com:dracor-org/einakter.git
cd einakter
yarn
yarn start

In the project directory, you can run:

`yarn start`

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

`yarn test`

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

`yarn build`

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

`yarn json`

Transforms data.yaml into JSON creating file data.json. This script is mostly used behind the scenes for yarn start and yarn build but can come in handy when a fresh JSON version of the current data is needed.

`yarn csv`

Generates CSV file data.csv from data.yaml.

`yarn authors`

Update authors.json. This fetches author data for new author IDs in data.yaml and adds it to src/authors.json.

To update existing IDs they can be passed as arguments:

yarn authors Q123 Q4566

`yarn locations`

Update locations.json. This fetches coordinates for new location IDs in data.yaml and adds them to src/locations.json.

`yarn extract`

Extracts translatable text from Javascript code and updates .po files in the src/locales directory.

`yarn compile`

Compiles .po files in the src/locales directory to Javascript. This is normally run by yarn start and yarn build. It would only need to be executed for testing new translations in a development server without re-running yarn start.

Translations

Einakter uses LinguiJS to provide a multi-lingual user interface. Translations are maintained in .po files in the src/locales. For updating translations the yarn extract and yarn compile commands can be used.

License

The code of this project is licensed under the MIT License.

The data files (data.yaml, originals.yaml) are licensed under CC BY 4.0.

v-ji / einakter