diff --git a/webUI/README.md b/webUI/README.md deleted file mode 100644 index b0f9d83..0000000 --- a/webUI/README.md +++ /dev/null @@ -1,58 +0,0 @@ -# hesabixUI - -This repository is part of [hesabix ](https://hesabix.ir)Project , first opensource accounting software in persian language. - -## Recommended IDE Setup - -[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin). - -## Type Support for `.vue` Imports in TS - -TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types. - -If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps: - -1. Disable the built-in TypeScript Extension - 1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette - 2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)` -2. Reload the VSCode window by running `Developer: Reload Window` from the command palette. - -## Customize configuration - -See [Vite Configuration Reference](https://vitejs.dev/config/). - -## Project Setup - -```sh -npm install -``` - -### Compile and Hot-Reload for Development - -```sh -npm run dev -``` - -After run this command you can access with [http://localhost:5173](http://localhost:5173) in your browser - -### Configure API Url in hesabixConfig.js - -open src/hesabixConfig.js and replace default return values of functions like application name and api address of [hesabix Core](https://github.com/morrning/hesabixCore). - -```js -return 'https://next.hesabix.ir'; -``` - -### Type-Check, Compile and Minify for Production - -```sh -npm run build-only -``` - -**All output files will be generated in the dist folder, which will be able to run on the web server** - -### Contributors - - - -