https://github.com/c7w/reqman-frontend

Your Requirement Management Servant, ReqMan. Project for Software Engineering of 2022 Spring.

https://github.com/c7w/reqman-frontend

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    1 of 6 committers (16.7%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (3.2%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

Your Requirement Management Servant, ReqMan. Project for Software Engineering of 2022 Spring.

Basic Info
  • Host: GitHub
  • Owner: c7w
  • Language: TypeScript
  • Default Branch: dev
  • Homepage:
  • Size: 4.26 MB
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Created about 4 years ago · Last pushed about 4 years ago
Metadata Files
Readme

README.md

Frontend

For Users

你需要在拉取仓库后在本地创建 .env.local 文件,并指定你的测试后端路径:

REACT_APP_BACKEND_URL=https://backend-dev-undefined.app.secoder.net

当然为防止测试环境发生数据大型丢失,你可以在本地拉取后端仓库后以 sqlite3 模式运行,并在这里填写你的本地后端回调地址。

For Developers

请先阅读项目规范,然后再继续阅读本部分。

  • IDE: WebStorm:**latest** (recommended)

    • Or vscode with eslint and prettier configurated
  • yarn install 补全 node_modules

  • yarn start 开启本地网页

  • yarn fix 使用 prettier 自动修复风格化问题

  • yarn lint 使用 eslint 检查是否存在格式问题

项目安装了 .husky pre-commit 钩子,在每次 commit 的时候自动运行 yarn lint,只有没有格式问题时才允许 commit.

在 push 之前请确保本地运行 yarn lintyarn build 没有问题,不然就算是 push 了也过不了 CI 测试,不允 Pull Request.

关于 Slice 在不同 Route 之间同步,参见: + https://github.com/supasate/connected-react-router

前端项目路径规范

  • assets 存储静态资源
  • Layout 中放置基本的外观组件
  • Components 中放置功能组件的外表
  • store 中存储全局变量
    • functions 中存储与后端通信用函数
    • slices 中存储变量状态的 Slice
  • page 中存储功能部件
    • Router.tsx 全局路由
    • route 中存储不同的功能部件

./page/route 中的功能部件通过调用 ./store/ 中的 reducers / getter 读取/写入变量状态(与后端通信),然后将数据作为 props 给 ./components./layout 并将该组件 return,使其能够成功渲染。

Owner

  • Name: Huan-ang Gao
  • Login: c7w
  • Kind: user
  • Location: Beijing, China
  • Company: Tsinghua University

Junior @ Computer Science and Technology, Tsinghua Univ. && Research Intern @AIR-DISCOVER

GitHub Events

Total
Last Year

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 486
  • Total Committers: 6
  • Avg Commits per committer: 81.0
  • Development Distribution Score (DDS): 0.564
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
c7w a****n@c****f 212
何秉翔 2****4@s****t 158
qiancheng q****0@m****n 110
HBX-hbx 1****4@q****m 3
teburile 1****3@q****m 2
高焕昂 2****1@s****t 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 143
  • Total pull requests: 0
  • Average time to close issues: less than a minute
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 5.68
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • c7w (143)
Pull Request Authors
Top Labels
Issue Labels
bug (13) logic (13) high priority (7) infrastructure (6) ui (5) feature (5) enhancement (1) style (1)
Pull Request Labels