Skip to content

Marking and making notes when read source code, generate blog

Notifications You must be signed in to change notification settings

tensor1014/source-code-blog

Repository files navigation

source-code-blog

Features

  • frontend
    • clone source code from git
    • read source code
    • mark and take notes
    • generate blog using structure notes and source code (like react-router doc)
    • visualization

Quick Start

  • server
    • dependencies
      • mysql
    • set environment variables
      • GITHUB_USERNAME=tensor1014
      • GITHUB_TOKEN=ce******
      • REPO_DIR=/Users/tensor1014/repositories // 源码目录
      • TREE_DIR=/Users/tensor1014/tree // 缓存文件树
      • MYSQL_USER=root
      • MYSQL_PASSWORD=vtu123456
      • MYSQL_DATABASE=source_code_reader
    • start
      • ./code-reader-server
  • frontend
    • yarn intall
    • yarn start

About

Marking and making notes when read source code, generate blog

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published