52 lines
1.0 KiB
Markdown
52 lines
1.0 KiB
Markdown
# Taker of Notes App
|
|
|
|
An Electron application with Vue
|
|
|
|
## Recommended IDE Setup
|
|
|
|
- [VSCode](https://code.visualstudio.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
|
|
|
|
## Project Setup
|
|
|
|
### Install
|
|
|
|
```bash
|
|
$ npm install
|
|
```
|
|
|
|
### Development
|
|
|
|
```bash
|
|
$ npm run dev
|
|
```
|
|
|
|
### Build
|
|
|
|
```bash
|
|
# For windows
|
|
$ npm run build:win
|
|
|
|
# For macOS
|
|
$ npm run build:mac
|
|
|
|
# For Linux
|
|
$ npm run build:linux
|
|
```
|
|
|
|
### Releasing Versions
|
|
|
|
Before releasing a new version, make sure that all code is committed and pushed to the remote repository. Then, update the version number in `package.json`.
|
|
|
|
Create a new release tag and push it to the remote repository.
|
|
|
|
```bash
|
|
$ git tag -a <version> -m "Release <version>"
|
|
$ git push --tags
|
|
```
|
|
|
|
Run the release script to build and package the application and upload it to the SeaweedFS bucket.
|
|
|
|
```bash
|
|
$ npm run release:<platform>
|
|
```
|