logseq-plugin-react-boilerplate

KO | EN

gitlite — search

#python #machine-learning #javascript #react #typescript #nextjs #rust #csharp #linux #flutter #minecraft #java

logseq-plugin-react-boilerplate

★ 31 Open GitHub ↗

logseq-plugin-react-boilerplate with vite react typescript tailwindcss antd

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# logseq-plugin-react-boilerplate
> logseq-plugin-react-boilerplate with vite react typescript tailwindcss antd

[![latest release version](https://img.shields.io/github/v/release/haydenull/logseq-plugin-react-boilerplate)](https://github.com/haydenull/logseq-plugin-react-boilerplate/releases)
[![License](https://img.shields.io/github/license/haydenull/logseq-plugin-react-boilerplate?color=blue)](https://github.com/haydenull/logseq-plugin-react-boilerplate/blob/main/LICENSE)

## Demo
![demo](https://raw.githubusercontent.com/haydenull/logseq-plugin-react-boilerplate/main/screenshots/demo.gif)

## Pre Requirements
1. [nodejs](https://nodejs.org/)
2. [pnpm](https://pnpm.io/)

## Usage
1. Use this template create your own plugin
2. change `package.json` name to your own plugin name
3. change LICENSE to your own license
4. change logo.png to your own logo
5. run `pnpm install` to install dependencies

### Browser mode with HMR

1. run `pnpm dev` to start vite server
2. Open HTTP APIs server Feature in logseq settings
![](https://raw.githubusercontent.com/haydenull/logseq-plugin-react-boilerplate/main/screenshots/settings-api-server-feature.png)
3. add [Authorization tokens](https://haydenut.notion.site/English-fd47d1843e654f5485a07ef4935ed365?pvs=25#7a7a57de5a77480a84d30bc610d235c5) in logseq
   * API_SERVER=http://127.0.0.1:12315
   * API_TOKEN=123
![](https://raw.githubusercontent.com/haydenull/logseq-plugin-react-boilerplate/main/screenshots/api-server.png)
4. open `localhost:5173` in browser

> [!TIP]
> Browser mode cannot access logseq plugin settings, you can add a file `mocks/settings.local.json` to mock.

### Plugin mode
This mode doesn't support HMR, you need to run `pnpm build` and reload plugin in logseq to see the changes
1. run `pnpm build:plugin` to build plugin
2. Open Plugins feature in logseq settings
![](https://raw.githubusercontent.com/haydenull/logseq-plugin-react-boilerplate/main/screenshots/settings-plugin-feature.png)
3. Click `Load unpacked plugin` and select this project folder
![](https://raw.githubusercontent.com/haydenull/logseq-plugin-react-boilerplate/main/screenshots/load-plugin.png)

## Release new version
1. push to `main` branch
2. github ci will auto create a new release

> [!TIP]
> Commit message needs to follow the [semantic-release](https://github.com/semantic-release/semantic-release) specification

## Publish to [logseq marketplace](https://github.com/logseq/marketplace)

Create PR to add your plugin message to [logseq/marketplace](https://github.com/logseq/marketplace)

logseq-plugin-react-boilerplate

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README