Fist Face 项目技术文档

1. 安装指南

1.1 环境准备

在开始安装之前，请确保您的开发环境已经安装了以下工具：

• Ruby 1.9.2 或更高版本
• Bundler
• Git
• Heroku CLI

1.2 安装步骤

1. 创建一个 Gemfile 文件，内容如下：

   source 'http://rubygems.org'
   gem 'sinatra',  '~> 1.1'
   gem 'fistface', '~> 1.0'
   

2. 创建一个 rackup 文件 (config.ru)，内容如下：

   require 'rubygems'
   require 'bundler'
   Bundler.require
   run Sinatra::FistFace
   run Sinatra::Application
   

3. 安装依赖：

   bundle install
   

4. 初始化 Git 仓库并提交代码：

   git init
   git add .
   git commit -m 'Creating a Fist Face instance'
   

5. 创建 Heroku 应用并设置 Bamboo 栈：

   heroku create your-app-name-here --stack bamboo-mri-1.9.2
   

6. 配置 S3 存储桶：

   heroku config:add S3_URL=https://your-bucket.s3.amazonaws.com
   

7. 部署应用：

   git push heroku master
   

2. 项目的使用说明

2.1 在 Web 应用中使用

在您的 Web 应用中，通过以下方式引入字体：

<link href="http://replace-me.com/font-name.css" rel="stylesheet" type="text/css">

请将 href 替换为您的 @font-face web 服务的 URL。

2.2 字体文件上传

对于每个字体，您需要上传一个 CSS 文件到您的 S3 存储桶，例如：

@font-face {
  font-family: 'Chunk';
  font-weight: normal;
  font-style: normal;
  src: local('☺'), url('http://replace-me.com/chunk/chunk.ttf') format('truetype');
}

字体文件的目录结构应遵循以下约定：

font-name.css
font-name/
  font-name.eot
  font-name.otf
  font-name.svg
  font-name.ttf
  font-name.woff

3. 项目API使用文档

3.1 字体服务API

Fist Face 项目通过 HTTP 服务提供字体文件的访问。您可以通过以下方式访问字体文件：

• http://your-app-name.herokuapp.com/font-name.css
• http://your-app-name.herokuapp.com/font-name/font-name.ttf

3.2 缓存机制

Fist Face 通过 HTTP 缓存机制确保字体文件在同一浏览器中只下载一次。

3.3 跨域问题解决

Fist Face 解决了 Firefox 和其他浏览器中的 Access-Control-Allow-Origin 问题。

4. 项目安装方式

4.1 本地运行

要在本地运行 Fist Face 应用，请执行以下命令：

gem install bundler
bundle install
S3_URL=https://your-bucket.s3.amazonaws.com rackup

4.2 测试

运行测试用例：

rspec spec/app_spec.rb

5. 贡献与支持

如果您发现问题或有改进建议，请通过 GitHub Issues 和 Pull Requests 提交您的贡献。

6. 许可证

Fist Face 是基于 MIT 许可证发布的自由软件，详细信息请参阅 MIT-LICENSE 文件。