Project address: github.com/XYShaoKang/…

background

To solve the inconvenient problem of viewing PC local videos on mobile phones.

Previously, if you want to watch a PC video on your mobile phone, you need to do the following steps

  1. Set the folder to be shared or use WebDAV to share the folder
  2. Install a player or file browser that supports the protocols (SMB,WebDAV,FTP,NFS, etc.) on your phone
  3. Connect to the previously shared folder using IP and corresponding protocol
  4. Play the video

These steps are too cumbersome to watch in a single video, and they can take some time to figure out, even for someone familiar with various system configurations.

This project aims to solve this problem by using a single command to view video on a PC using a browser on a mobile phone.

The target

Create a command line tool to start a service through the command line. The core objective is to enable devices on the LAN to view video files in the specified local directory through a browser. More features will be added later, such as recording playback progress, pulling bullets (if any), authentication, etc

define

  • Monorepo: A project management approach in which multiple related projects are managed under one repository
    • Monorepo Wiki
    • Why one big repo
  • Rush is a management tool specifically designed to manage the Monorepo project
  • PNPM is a fast package management tool

Job content

  • Use Rush + PNPM to manage the project
  • Write all your code in TypeScript
  • React is used to implement the front interface
  • The CLI uses Yargs for command line processing and Koa for HTTP services
  • Automated testing, distribution, deployment, and more via GitHub + Travis CI

The project plan and the current progress

  • 8.23-8.24 Setting up an Environment
  • 8.25-8.29 Implement the front-end infrastructure
  • 8.29-9.2 Implementing the back-end CLI Function
  • 9.3
    • The CLI connects to the front end to run the entire life cycle
    • release
  • 9.3-9.5 Documentation preparation

Personal goal: Learn to use Rush + PNPM

Through practical use, familiarizing myself with Rush’s commands, deepening my understanding of the entire workflow when using Rush to maintain projects, as well as various tools and integration with Rush, and documenting and publishing articles on pothole logging using Rush + PNPM

Resources into

It took about 30 hours to complete on my own, using some spare time on weekdays and two weekends

demo

conclusion

  • Core CLI functions are complete
  • Learn to manage projects using Rush
  • Did you learn how to write documents