1 Star 1 Fork 0

臧大钊 / react-mobx-typescript

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Artistic-2.0

ReactMobxTypescript JavaScript Style Guide

react-mobx-typescript

需要

安装node.js

运行

  1. 运行npm install 安装所需模块
  2. 运行npm run dev 启动服务

发布

  • 测试 npm run test 构建测试代码
  • 准生产 npm run pre 构建准生产代码
  • 生产 npm run prod 构建生产代码

关于发布代码上线:

  1. 修改package.json文件中的 version 原则为末尾累加
  2. 修改 manifest.Json文件中的 version 保持与package.json 中 version一致
  3. 执行package.json 文件中 prod 命令

版本号递增原则

  • 单一功能升级或紧急修复 => 末尾版本号加一
  • 复杂内容更新或者API不兼容升级调整 => 中部版本号加一
  • 架构上的不兼容调整升级或不可降级调整升级 => 首位版本号加一

目录说明

  • src 目录存放前端代码
  • src/api 目录存放的是api接口
  • src/assets 目录存放的是项目资源
  • src/components 目录存放的是组件代码
  • src/http 目录存放的是封装的http请求
  • src/pages 目录存放的是页面代码
  • src/store 目录存放的是状态管理代码
  • src/utils 目录存放的是通用工具
  • types 项目Typescript 类型声明
  • doc 存放项目架构图

关于接口地址API_URL说明:

两种方式都可实现,灵活运用

  1. 在打包时有变量process.env.API_URL,这个参数只能定义string类型,可以在后续api地址中采用拼接方式使用。如:

    http://user.xxxxx${'-' + process.env.API_URL}.com/xxxx
    http://list.xxxxx${'-' + process.env.API_URL}.com/xxxx
  2. 如后端接口域名不统一,则可以使用src/api目录下的api_env.ts添加不同域名。如:

    // 开发环境接口地址 || 测试环境接口地址
    dev: {
      login: 'login.api-test.com',
      user: 'user.api-test.com',
    },
    // 准生产环境接口地址
    pre: {
      login: 'login.api-pre.com',
      user: 'user.api-pre.com',
    },
    // 生产环境接口地址
    prod: {
      login: 'login.api.com',
      user: 'user.api.com',
    },

关于git的使用

项目一般有个三个固定的远程分支develop(用于测试线)/release(用于预生产线)/master(用于正式线)

关于图标的使用

项目中建议优先使用矢量图标, 如果是多彩且无需大小变换的是可直接使用一般位图图标.拿到svg文件注意一下变量 需设置widthheight1em 单色图标需要移除其内部颜色 设置fillcurrentColor

TSX文件模板

import React from 'react'
import { hot } from 'react-hot-loader'

interface ${NAME}Props{}

class ${NAME} extends React.Component<${NAME}Props> {
  render () {
    return (<div id='${NAME}'>

    </div>)
  }
}
export default hot(module)(${NAME})

SVG 文件模板

<svg viewBox="0 0 1024 1024" width="1em" height="1em" fill="currentColor" version="1.1" xmlns="http://www.w3.org/2000/svg">
   
</svg>

Mobx引入模板

import { NAME } from '@store/NAME'
import { observer } from 'mobx-react'

@observer
The Artistic License 2.0 Copyright (c) 2000-2006, The Perl Foundation. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble This license establishes the terms under which a given free software Package may be copied, modified, distributed, and/or redistributed. The intent is that the Copyright Holder maintains some artistic control over the development of that Package while still keeping the Package available as open source and free software. You are always permitted to make arrangements wholly outside of this license directly with the Copyright Holder of a given Package. If the terms of this license do not permit the full use that you propose to make of the Package, you should contact the Copyright Holder and seek a different licensing arrangement. Definitions "Copyright Holder" means the individual(s) or organization(s) named in the copyright notice for the entire Package. "Contributor" means any party that has contributed code or other material to the Package, in accordance with the Copyright Holder's procedures. "You" and "your" means any person who would like to copy, distribute, or modify the Package. "Package" means the collection of files distributed by the Copyright Holder, and derivatives of that collection and/or of those files. A given Package may consist of either the Standard Version, or a Modified Version. "Distribute" means providing a copy of the Package or making it accessible to anyone else, or in the case of a company or organization, to others outside of your company or organization. "Distributor Fee" means any fee that you charge for Distributing this Package or providing support for this Package to another party. It does not mean licensing fees. "Standard Version" refers to the Package if it has not been modified, or has been modified only in ways explicitly requested by the Copyright Holder. "Modified Version" means the Package, if it has been changed, and such changes were not explicitly requested by the Copyright Holder. "Original License" means this Artistic License as Distributed with the Standard Version of the Package, in its current version or as it may be modified by The Perl Foundation in the future. "Source" form means the source code, documentation source, and configuration files for the Package. "Compiled" form means the compiled bytecode, object code, binary, or any other form resulting from mechanical transformation or translation of the Source form. Permission for Use and Modification Without Distribution (1) You are permitted to use the Standard Version and create and use Modified Versions for any purpose without restriction, provided that you do not Distribute the Modified Version. Permissions for Redistribution of the Standard Version (2) You may Distribute verbatim copies of the Source form of the Standard Version of this Package in any medium without restriction, either gratis or for a Distributor Fee, provided that you duplicate all of the original copyright notices and associated disclaimers. At your discretion, such verbatim copies may or may not include a Compiled form of the Package. (3) You may apply any bug fixes, portability changes, and other modifications made available from the Copyright Holder. The resulting Package will still be considered the Standard Version, and as such will be subject to the Original License. Distribution of Modified Versions of the Package as Source (4) You may Distribute your Modified Version as Source (either gratis or for a Distributor Fee, and with or without a Compiled form of the Modified Version) provided that you clearly document how it differs from the Standard Version, including, but not limited to, documenting any non-standard features, executables, or modules, and provided that you do at least ONE of the following: (a) make the Modified Version available to the Copyright Holder of the Standard Version, under the Original License, so that the Copyright Holder may include your modifications in the Standard Version. (b) ensure that installation of your Modified Version does not prevent the user installing or running the Standard Version. In addition, the Modified Version must bear a name that is different from the name of the Standard Version. (c) allow anyone who receives a copy of the Modified Version to make the Source form of the Modified Version available to others under (i) the Original License or (ii) a license that permits the licensee to freely copy, modify and redistribute the Modified Version using the same licensing terms that apply to the copy that the licensee received, and requires that the Source form of the Modified Version, and of any works derived from it, be made freely available in that license fees are prohibited but Distributor Fees are allowed. Distribution of Compiled Forms of the Standard Version or Modified Versions without the Source (5) You may Distribute Compiled forms of the Standard Version without the Source, provided that you include complete instructions on how to get the Source of the Standard Version. Such instructions must be valid at the time of your distribution. If these instructions, at any time while you are carrying out such distribution, become invalid, you must provide new instructions on demand or cease further distribution. If you provide valid instructions or cease distribution within thirty days after you become aware that the instructions are invalid, then you do not forfeit any of your rights under this license. (6) You may Distribute a Modified Version in Compiled form without the Source, provided that you comply with Section 4 with respect to the Source of the Modified Version. Aggregating or Linking the Package (7) You may aggregate the Package (either the Standard Version or Modified Version) with other packages and Distribute the resulting aggregation provided that you do not charge a licensing fee for the Package. Distributor Fees are permitted, and licensing fees for other components in the aggregation are permitted. The terms of this license apply to the use and Distribution of the Standard or Modified Versions as included in the aggregation. (8) You are permitted to link Modified and Standard Versions with other works, to embed the Package in a larger work of your own, or to build stand-alone binary or bytecode versions of applications that include the Package, and Distribute the result without restriction, provided the result does not expose a direct interface to the Package. Items That are Not Considered Part of a Modified Version (9) Works (including, but not limited to, modules and scripts) that merely extend or make use of the Package, do not, by themselves, cause the Package to be a Modified Version. In addition, such works are not considered parts of the Package itself, and are not subject to the terms of this license. General Provisions (10) Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license. (11) If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license. (12) This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder. (13) This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed. (14) Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

简介

react+mobx+typescript 搭建的项目 展开 收起
TypeScript 等 4 种语言
Artistic-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/da_zhao_zang/react-mobx-typescript.git
git@gitee.com:da_zhao_zang/react-mobx-typescript.git
da_zhao_zang
react-mobx-typescript
react-mobx-typescript
master

搜索帮助

53164aa7 5694891 3bd8fe86 5694891