Kanri 开源项目使用教程

史淳莹Deirdre

于 2024-09-10 09:53:30 发布

阅读量367

点赞数 4

本文链接：https://blog.csdn.net/gitblog_00741/article/details/142088027

版权

Kanri 开源项目使用教程

kanri🪐 Modern offline Kanban board app for Windows, MacOS and Linux. Built with simplicity and user experience in mind.项目地址:https://gitcode.com/gh_mirrors/ka/kanri

1. 项目的目录结构及介绍

kanri/
├── app/
│   ├── controllers/
│   ├── models/
│   ├── views/
│   └── ...
├── config/
│   ├── database.yml
│   ├── environment.rb
│   └── ...
├── public/
│   ├── assets/
│   ├── images/
│   └── ...
├── spec/
│   ├── controllers/
│   ├── models/
│   └── ...
├── Gemfile
├── Gemfile.lock
├── README.md
└── ...

目录结构介绍

app/: 包含应用程序的核心代码，包括控制器、模型和视图。
- controllers/: 存放控制器文件，处理用户请求。
- models/: 存放模型文件，处理数据逻辑。
- views/: 存放视图文件，负责展示数据。
config/: 包含项目的配置文件。
- database.yml: 数据库配置文件。
- environment.rb: 环境配置文件。
public/: 存放静态资源文件，如图片、样式表等。
- assets/: 存放静态资源文件。
- images/: 存放图片文件。
spec/: 存放测试文件。
- controllers/: 控制器测试文件。
- models/: 模型测试文件。
Gemfile: 定义项目所需的 RubyGems。
Gemfile.lock: 锁定 Gemfile 中定义的 Gem 版本。
README.md: 项目说明文件。

2. 项目的启动文件介绍

项目的启动文件通常位于 config/ 目录下，主要包括 environment.rb 和 application.rb。

environment.rb

environment.rb 是项目的全局配置文件，负责加载项目所需的所有依赖项和配置。

# config/environment.rb
require 'bundler/setup'
Bundler.require(:default, ENV['RACK_ENV'] || 'development')

require_relative '../app/controllers/application_controller'

application.rb

application.rb 是应用程序的主文件，负责启动应用程序。

# config/application.rb
require_relative 'environment'

run ApplicationController

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 目录下，包括数据库配置、环境配置等。

database.yml

database.yml 是数据库配置文件，定义了不同环境下的数据库连接信息。

# config/database.yml
default: &default
  adapter: postgresql
  encoding: unicode
  pool: 5

development:
  <<: *default
  database: kanri_development
  username: kanri
  password: password

test:
  <<: *default
  database: kanri_test
  username: kanri
  password: password

production:
  <<: *default
  database: kanri_production
  username: kanri
  password: <%= ENV['KANRI_DATABASE_PASSWORD'] %>

environment.rb

environment.rb 是环境配置文件，定义了项目的环境变量和全局配置。

# config/environment.rb
ENV['RACK_ENV'] ||= 'development'

require 'bundler/setup'
Bundler.require(:default, ENV['RACK_ENV'])

Dotenv.load

require_relative '../app/controllers/application_controller'

以上是 Kanri 开源项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用该项目。

kanri🪐 Modern offline Kanban board app for Windows, MacOS and Linux. Built with simplicity and user experience in mind.项目地址:https://gitcode.com/gh_mirrors/ka/kanri