https://github.com/alephium/desktop-wallet
The official Alephium wallet for desktop
https://github.com/alephium/desktop-wallet
alephium electron hacktoberfest
Last synced: 5 months ago
JSON representation
The official Alephium wallet for desktop
- Host: GitHub
- URL: https://github.com/alephium/desktop-wallet
- Owner: alephium
- License: lgpl-3.0
- Created: 2020-09-11T15:19:07.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-29T05:49:40.000Z (over 2 years ago)
- Last Synced: 2024-01-30T02:56:48.616Z (over 2 years ago)
- Topics: alephium, electron, hacktoberfest
- Language: TypeScript
- Homepage: https://alephium.org
- Size: 11.8 MB
- Stars: 78
- Watchers: 10
- Forks: 50
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## ⚠️ Deprecation warning: This repository has been integrated into the [Alephium frontend monorepo](https://github.com/alephium/alephium-frontend/) and is no longer maintained.
# Alephium desktop wallet
The official Alephium desktop wallet.
## Development
Install depedencies with:
```shell
npm install
```
To launch it as an electron app, run:
```shell
npm run start:electron
```
## Test
```shell
npm test
```
## Packaging
The command below will detect your OS and build the corresponding package:
```shell
npm run electron-pack
```
To build for ARM64 Linux, run:
```shell
npm run electron-pack-linux:arm64
```
## Release
To release a new version:
1. Checkout the master branch:
```shell
git checkout master
```
2. Create a commit that updates the package version in package.json and package-lock.json and a tag with:
```shell
npm version patch # if you want to bump the patch version
npm version minor # if you want to bump the minor version
npm version major # if you want to bump the major version
npm version prepatch --preid=rc # if you want to create a release candidate and bump the patch version
npm version preminor --preid=rc # if you want to create a release candidate and bump the minor version
npm version premajor --preid=rc # if you want to create a release candidate and bump the major version
```
3. Push the new commit and new tag to GitHub to trigger the release workflow that will build the downloadable binaries:
```shell
git push
git push [remote]
```
## Adding new translation
1. Copy `locales/fr-FR/translation.json` into `locales/[xx-YY]/translation.json` and add your translations.
2. Import new translation file and add it to the resources in `src/i18n.ts`
```ts
import en from '../locales/en-US/translation.json'
import fr from '../locales/fr-FR/translation.json'
i18next.use(initReactI18next).init({
resources: {
'en-US': { translation: en },
'fr-FR': { translation: fr }
}
})
```
3. Add new language option in `src/utils/settings.ts`
```ts
const languageOptions = [
{ label: 'English', value: 'en-US' },
{ label: 'Français', value: 'fr-FR' }
]
```
4. Import `dayjs` translation file in `src/storage/settings/settingsSlice.ts`
```ts
import 'dayjs/locale/fr'
```