ngForce 开源项目安装与使用手册

ngForce 开源项目安装与使用手册

ngForce Force.com && Angular.js integration framework. 项目地址: https://gitcode.com/gh_mirrors/ng/ngForce

1. 目录结构及介绍

ngForce 是一个旨在加速基于Angular.js在Force.com平台上的应用程序开发的集成框架。以下是该项目的基本目录结构及其内容概述：

ngForce/
├── build                   # 构建相关文件或脚本
├── gruntfile.js            # Grunt构建工具配置文件
├── LICENSE                 # 许可证文件，遵循MIT协议
├── README.md               # 项目说明文档
├── bower.json              # Bower依赖管理文件
├── package.json            # npm包管理配置文件
└── src                     # 源代码目录
    ├── ngForce-visualForceRemoting.js  # 提供与Force.com交互的服务
    ├── ngForce-sfTemplate.js          # 优化从Visualforce页面提取的Angular视图
    ├── ngForce-sfrQuery.js            # 通过REST API查询Salesforce记录的服务
    ├── ngForce-sfrBackend.js          # 测试辅助服务
    ├── ngForce-sfrAnalytics.js        # 访问Salesforce Analytics REST API的服务
    ├── ngForce-sfr.js                  # 主要REST API服务
    ├── ngForce-remoteObjects.js       # 远程对象方法的工厂服务
    ├── ngForce-encodeUriQuery.js      # URI查询编码服务
    ├── ...                            # 其他相关模块和服务
    └── lib                            # 第三方库（如Lo-Dash.js）存放位置

每个JavaScript源文件对应特定的功能模块，构成ngForce的核心功能集合。

2. 项目的启动文件介绍

该项目并未明确指出一个单一的“启动文件”，因为它主要用于作为Angular.js应用的一个依赖库。然而，在使用ngForce时，主要是在你的Angular.js应用中引入它并通过配置模块来“启动”ngForce的功能。这通常发生在你的Angular应用的主要配置文件中，例如app.js（尽管此文件名在示例中未直接提供），通过以下方式注入依赖并配置服务：

var app = angular.module('myApp', ['ngForce']);
app.config(function (ngForceProvider) {
    // 配置ngForce的选项，如果需要的话
});

3. 项目的配置文件介绍

ngForce本身的配置主要是通过在你的Angular应用内部进行的，比如通过服务提供商(ngForceProvider)进行自定义设置。虽然没有直接的外部配置文件如.config或.env，但可以通过以下几个方面进行配置：

• 在App初始化时配置: 利用Angular的provider模式，在你的应用配置阶段（app.config()）通过ngForceProvider调整默认选项。

  app.config(function(ngForceProvider) {
      ngForceProvider.setSomeOption('yourValue');
  });
  

• 环境变量或外部依赖: 对于任何依赖于运行环境的配置，如API端点或认证信息，通常不在ngForce本身管理，而是通过环境变量或手工导入到你的项目中。

由于ngForce依赖于Angular.js的模块系统，大部分配置逻辑是在你的应用层面上完成，而不是在ngForce仓库直接提供的配置文件里。因此，确保理解你的Angular.js应用如何与这些服务交互，并在应用层面做相应的配置。

ngForce Force.com && Angular.js integration framework. 项目地址: https://gitcode.com/gh_mirrors/ng/ngForce