kromit/siwapp

Siwapp

![构建状态]([***]

在线发票管理系统。查看在线演示（用户：***，密码：secret）。

https://github.com/siwapp/siwapp/blob/master/API_DOC.md

镜像概述和主要用途

Siwapp是一个基于Ruby on Rails开发的在线发票管理工具，提供发票创建、管理、发送等核心功能，支持API集成和自动化操作，适用于需要高效管理发票流程的个人或企业。

核心功能和特性

• 在线发票创建与管理
• 支持通过SMTP配置发送邮件
• 提供API接口，便于系统集成
• 支持定期发票自动生成
• 开源且可部署在多种平台（如Heroku）

使用场景和适用范围

• 小型企业发票管理
• 自由职业者账单生成与跟踪
• 需要自动化发票流程的团队
• 需通过API与其他业务系统集成的场景

使用方法和配置说明

SMTP配置

为使应用能够发送邮件，需配置以下环境变量：

SMTP_HOST          # SMTP服务器地址
SMTP_PORT          # SMTP服务器端口
SMTP_DOMAIN        # 邮件发送域名
SMTP_USER          # SMTP认证用户名
SMTP_PASSWORD      # SMTP认证密码
SMTP_AUTHENTICATION  # 认证方式（可选值：plain | login | cram_md5）
SMTP_ENABLE_STARTTLS_AUTO  # 是否启用STARTTLS（设置为1启用）

Heroku部署步骤

1. 克隆仓库
   首先将Siwapp仓库克隆到本地：

   bash
   $ git clone git@github.com:siwapp/siwapp.git
   $ cd siwapp
   

2. 创建Heroku应用
   在终端中登录Heroku后，创建应用（示例名称为"siwapp-demo"，可自定义）：

   bash
   $ heroku apps:create siwapp-demo
   # 若需指定区域（如欧洲）和构建包
   $ heroku apps:create --region eu --buildpack heroku/ruby siwapp-demo
   

3. 添加必要插件
   添加PostgreSQL数据库和调度器插件：

   bash
   $ heroku addons:create heroku-postgresql
   $ heroku addons:create scheduler:standard
   

4. 推送代码并初始化数据库
   将代码推送到Heroku并设置数据库：

   bash
   $ git push heroku
   $ heroku run rake db:setup
   

5. 创建管理员用户
   执行以下命令创建登录用户：

   bash
   $ heroku run "rake siwapp:user:create['用户名','邮箱地址','密码']"
   

   示例：

   bash
   $ heroku run "rake siwapp:user:create['demo','demo@example.com','secret_password']"
   

6. 配置定期发票自动生成
   打开Heroku调度器插件配置自动任务：

   bash
   $ heroku addons:open scheduler
   

   添加新任务，输入命令：rake siwapp:generate_invoices，设置执行频率（如每天）。

7. 访问应用
   完成配置后，通过以下命令打开应用：

   bash
   $ heroku apps:open