aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: f86424f0e0e9fd8a788d0a566736119fc44a43ec (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# coinos-ui-v2

[![Netlify Status](https://api.netlify.com/api/v1/badges/dc5c8c09-6b16-4878-afb4-a288c26cc9b1/deploy-status)](https://app.netlify.com/sites/coinos/deploys)

coinos is an easy to use bitcoin point of sale application for businesses and wallet for customers, connecting the bitcoin circular economy together.

this repository is the front-end code for the coinos web application, it uses `sveltekit` as the javascript framework, `tailwindcss` for inline styling, `pnpm` as the recommended package manager and `prettier` for code formatting.

## commands

to get started clone the repo and run `pnpm install`, then `pnpm run dev` to get your dev environment setup, and `pnpm format` to format the codebase when making changes.

## Internationalization

CoinOS has a system for translation using [`svelte-i18n`](https://www.npmjs.com/package/svelte-i18n). For more information and instructions on how to translate CoinOS, click [here](./doc/i18n.md). For technical details, click [here](./doc/i18n-technical.md).