Skip to content

Latest commit

 

History

History
96 lines (70 loc) · 4.03 KB

README.md

File metadata and controls

96 lines (70 loc) · 4.03 KB
Raw

KristWeb v2 Donate on PayPal GitHub Workflow Status Codacy grade Lines of code GitHub issues GitHub pull requests GitHub package.json version GitHub

STILL IN DEVELOPMENT

This project is heavily under development. It is currently in the design stages, meaning there is no useful functionality yet.

Rewrite of the Krist Web Wallet, in React. This is a fully clientside Krist wallet that only needs to communicate to the Krist node itself. It securely saves wallets encrypted in your browser's Local Storage, so you don't have to type in wallet passwords ever again!

Building (for development)

git clone https://github.com/tmpim/KristWeb2
cd KristWeb2

yarn install
npm start # Run the development server

Building (for production)

git clone https://github.com/tmpim/KristWeb2
cd KristWeb2
yarn install
yarn run full-build # Build the production files

Contributing

As per tmpim convention, this project uses Conventional Commits as a standard for commit messages.

Contributing translations

Translation files are currently created manually in the i18next JSON format, with support for JSON5 syntax. You can find existing translations in public/locales. The English (GB) translation is used as the fallback.

Language files are named with IETF language tags. Short tags (e.g. en instead of en-GB) are preferred.

IMPORTANT: If you are adding a new language, you must add a listing for the language with the English name, native name, a country code (for the flag) and the contributors list to src/__data__/languages.json. It's not terribly important, but the list should be kept in alphabetical order by language code.

The keys antLocale, dayjsLocale and timeagoLocale are all optional keys that refer to the locale names from the respective libraries. If the library does not support your language, create an issue on this repo or mention it in your PR, because I can add a simple system to support custom translations for these libraries if it is needed, though you should also PR to the libraries themselves.

List of supported locale codes for each library:

The library will automatically detect the language from your browser to use, but for the sake of testing, you can override it by running the following command in the developer console (Ctrl+Shift+I):

localStorage.i18nextLng = "en";

If you need any help with specific i18next features (e.g. handling plurals), don't hesitate to contact Lemmmy.

Donate

If you like my work, and want to help me with this hobby project and many more in the future, please consider donating.

License

Copyright (c) 2020-2021 Drew Lemmy

This project is licensed under the AGPL v3 license. See LICENSE.txt for more.