Skip to content

Commit

Permalink
docs: move roadmap to github projects
Browse files Browse the repository at this point in the history
  • Loading branch information
Discreater committed Dec 5, 2023
1 parent da64f66 commit 6c35ea3
Showing 1 changed file with 7 additions and 41 deletions.
48 changes: 7 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,6 @@

You can download the prebuilt installer from the newest successful build of the [Github Actions](https://github.com/Discreater/QSync/actions). (Only Windows is supported now)

## Roadmap

### MuSync
- [x] Music Player
- [x] Local Music Library
- [x] Sync play through websocket
- [x] Unified Track ID
- [x] [Media Session API](https://developer.mozilla.org/en-US/docs/Web/API/MediaSession)
- Search Music
- [x] Local
- [ ] Remote
- [ ] Remote Music Library
- Netease
- QQ Music
- Bilibili
- Migu
- Youtube
- [ ] Lyric
- [ ] Download metadata

### Common

- [x] User Management
- token auth
- [x] Websocket Message
- [ ] Add client id (Each websocket connection has a unique client id)


## FIXME
- [ ] Login logic(frontend)
- [ ] Refactor client player
- Player mute state wrong.
- May use `APlayer`?

## Tech Stack

- Server
Expand All @@ -46,8 +12,8 @@ You can download the prebuilt installer from the newest successful build of the
- sea-orm: orm
- sqlite: database
- Frontend
- Vite
- Vue
- Vite
- Typescript
- TailwindCSS

Expand All @@ -59,14 +25,19 @@ You can download the prebuilt installer from the newest successful build of the
JWT_SECRET=JJJWWW
```

- Generate typescript protobuf client, if you change the proto files in `protos/`. Rust grpc server code will audo generated when building.
- Generate typescript protobuf client, if you have modified the proto files in `protos/`. Rust grpc server code will audo generated when building.
```bash
# windows
protoc --plugin=protoc-gen-ts_proto=".\\node_modules\\.bin\\protoc-gen-ts_proto.cmd" --ts_proto_out=./src/generated --ts_proto_opt=esModuleInterop=true --ts_proto_opt=outputClientImpl=grpc-web ./protos/musync.proto
# others
protoc --plugin=./node_modules/.bin/protoc-gen-ts_proto --ts_proto_out=./src/generated --ts_proto_opt=esModuleInterop=true --ts_proto_opt=outputClientImpl=grpc-web ./protos/musync.proto
```

## Run in Tauri client
```
pnpm tauri dev
```

## Run in Web

Server will run on `localhost:8396`.
Expand All @@ -83,8 +54,3 @@ cargo run --example server
```
pnpm dev
```

## Run in Tauri client
```
pnpm tauri dev
```

0 comments on commit 6c35ea3

Please sign in to comment.