🏞️ thuringian-field-names

Explorer for the Thuringian Field Name Archive.

The project is developed as part of the Client-side web applications lecture at Martin Luther University Halle-Wittenberg.

User stories

Please refer to the user stories for details on the implemented features.

Usage

The field name explorer is a React app, built and run with Yarn. Note that you must specify API credentials for the app to work.

Run

Run the app locally in development mode (page reloads on edits):

yarn start

Now you use the app from http://localhost:3000 in your web browser

Test

Run Cypress tests:

yarn test

For more information, see the cypress directory.

Bundle

Build the app for production:

yarn build

You'll find the bundled and optimized app in the build folder, ready for deployment.

API credentials

For accessing the field name API, you must specify username and password to the backend API. Create a file .env.local with the following content (replace user and pass with your credentials):

REACT_APP_API_USERNAME=user
REACT_APP_API_PASSWORD=pass

The app won't work without specifying API credentials. Note that you need to restart the development server for changes to take effect.

License

This project is MIT licensed, you can use it for whatever you want as long as you mention this repository. We use the React framework which is also open source. Some texts used in the app are copyright of the Thuringian Field Name Archive.