github上项目的目录结构说明
build 构建脚本
dist 编译出来的发布版
docs 文档
examples 示例文件
src 源码
test 测试脚本
.babelrc Babel 交叉编译的配置
.eslintrc ESLint 测试配置
.gitignore 哪些文件不要上传到 GitHub
.gitattributes 文件属性,如 EOL、是否为二进制等
LICENSE 授权协议
README.md 自述文件,里面至少得写:
项目的特色
各种 Badge 比如 CI 的
怎么下载安装
示例运行/使用
怎么编译(尤其 C/C++,要把编译器、要装什么工具、依赖库全部写清楚。要带版本号!)
怎么参与
circle.yml Circle CI 持续集成配置文件(当然你可能用别的 CI,名字会变。比如我那个 otfcc 使用了两个 CI:Travis 和 Appveyor,就写了两个配置)
bower.json Bower 包管理器配置文件
package.json npm 包管理器配置文件
---------------------
github的使用-目录解析
从github下载的项目目录,总有一些刚开始我们不了解用处的文件,本文尝试做一些整理归纳,希望你看了本文可以有所帮助,更有效率的使用github。
gitignore文件:定义不想在git中提交的文件
readMe:比较常见的项目说明文档,通常是markdown格式的,后缀为md
package.json文件(javaScript项目):定义项目所需要的各种模块,以及项目的配置信息(比如名称、版本、许可证等元数据)。npm install 命令根据这个配置文件,自动下载所需的模块
gruntfile.js(javaScript项目):https://blog.csdn.net/anway12138/article/details/79455365
composer.json:composer的配置文件, Java有Maven, Node.js有npm, composer就是PHP程序员的包管理工具。
bower.json:配置文件(什么是bower?一个前端包管理工具。作用:跟踪前端包,并且保证他们是最新(或者是你指定的特定版本),能够管理前端里面的HTML,CSS,JS,甚至还可以是图片。如果多个包依赖于一个包,例如jQuery,那么Bower将只下载jQuery一次,这样就称为扁平依赖,它有助于减少页面加载。)
dist文件夹:编译后或者压缩后的代码
src文件夹:源码文件
assets文件夹:储存js、css、图片等静态资源
static文件夹:储存第三方静态资源(例如jquery.js, bootstrap.css等)
注:最后编译发布的时候会将所有的静态资源整合到 /dist/static/ 目录下,包括assets文件夹中的静态资源。
github上项目的目录结构说明的更多相关文章
- Go 项目的目录结构 及 安装技巧
项目目录结构如何组织,一般语言都是没有规定.但 Go 语言这方面做了规定,这样可以保持一致性 1.一般的,一个 Go 项目在 GOPATH 下,会有如下三个目录: |--bin |--pkg |--s ...
- Maven项目的目录结构+maven的安装与配置
1.首先下载maven,然后配置环境变量,在MyEclipse里面配置maven 2.配置maven的pom.xml文件 3.下载和更新资源 右击项目,有一个Maven4Myeclipse,里面有三个 ...
- ASP.NET MVC 入门2、项目的目录结构与核心的DLL
我们新建一个ASP.NET MVC的Web Application后,默认的情况下,项目的目录结构如下: App_Data :这个目录跟我们一般的ASP.NET website是一样的,用于存放数据. ...
- [转]ASP.NET MVC 入门2、项目的目录结构与核心的DLL
我们新建一个ASP.NET MVC的Web Application后,默认的情况下,项目的目录结构如下: App_Data :这个目录跟我们一般的ASP.NET website是一样的,用于存放数据. ...
- android学习——项目的目录结构
学习开发之前要了解工程目录下的文件夹下文件的用意,是以HelloWorld为例: 1.HelloWorld项目的目录结构 1.1.src文件夹 1.2.gen文件夹 1.3.Android 2.1文件 ...
- Maven项目的目录结构
刚接触Maven没多长时间,实习时在的小公司很不规范,所有web项目都是dynamic web project搭建,没有用到项目构建,管理工具,导致了非常多的重复工作与低效. 先来看看Maven的功能 ...
- 使用Maven构建Web项目的目录结构
1.Web项目的目录结构 基于Java的Web项目,标准的打包方式是WAR.与JAR比较,包含更多的内容,比如JSP文件.Servlet.Java类.web.xml配置文件.依赖JAR包.静态 ...
- 从零开始:一个正式的vue+webpack项目的目录结构是怎么形成的
如何从零开始一个vue+webpack前端工程工作流的搭建,首先我们先从项目的目录结构入手.一个持续可发展,不断加入新功能,方便后期维护的目录结构究竟是长什么样子的?接下来闰土大叔带你们一起手摸手学起 ...
- Android开发之旅2:HelloWorld项目的目录结构
引言 前面Android开发之旅:环境搭建及HelloWorld,我们介绍了如何搭建Android开发环境及简单地建立一个HelloWorld项目,本篇将通过HelloWorld项目来介绍Androi ...
随机推荐
- git学习笔记 ---工作区和暂存区
Git和其他版本控制系统如SVN的一个不同之处就是有暂存区的概念. 先来看名词解释. 工作区(Working Directory) 就是你在电脑里能看到的目录,比如我的learngit文件夹就是一个工 ...
- 利用ime-mode设置文本框只能输入正整数
html: <input type="text" id="packageratio"style="ime-mode: disabled;&quo ...
- asp.net mvc 使用bootstrap的模态框插件modal
编译器:vs2012 jquery版本:jquery-1.10.2.js bootstrap:bootstrap.js v3.0.0,包含modal插件 我们要实现一个使用模态框展示从服务器获取的数据 ...
- 什么是MBR
MBR的定义 MBR(Main Boot Record)主引导记录是位于磁盘最前边的一段引导代码,由磁盘操作系统(DOS)在对磁盘初始化时产生,负责磁盘操作系统(DOS)对磁盘进行读写时磁盘分区合法性 ...
- JQ分页的使用
<script src="../js/pageMe.js"></script> <script src="../js/comjq.js&qu ...
- mysql的安装,启动,和基础配置 -----windows版本
下载: 第一步 : 打开网址(进入官网下载) : https://www.mysql.com , 点击downloads之后跳转到https://www.mysql.com/downloads 第二步 ...
- 前端js入门之 JavaScript 对象直接量
JavaScript中,创建对象可以使用构造函数方式. 代码实例如下: obj.webName = "博客园"; obj.address = "编程语言"; 以 ...
- Anaconda-Jupyter notebook 如何安装 nbextensions
系统环境:windows 安装过程中,再次遇到了一地鸡毛,经过不断查询方法,发现前辈大牛们好棒棒! Step1:确定是已经安装好anaconda Step2:要在anaconda prompt模式下运 ...
- SQL Server 字段提取拼音首字母
目前工作中遇到一个情况,需要将SQL Server中的一个字段提取拼音的首字母,字段由汉字.英文.数字以及“-”构成,百度了一堆,找到如下方法,记录一下,以备后用! 首先建立一个函数 --生成拼音首码 ...
- [daily][archlinux] pacman 安装软件时404的问题
时常,我们在archlinux上pacman安装一个软件时,会遇见如图这样的问题: “The requested URL returned error: 404” [classic_tong @ 2 ...