Dawarich 项目教程

Dawarich 项目教程

dawarichGoogle Location History (Google Maps Timeline) self-hosted alternative.项目地址:https://gitcode.com/gh_mirrors/da/dawarich

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

Dawarich 项目的目录结构如下：

dawarich/
├── Makefile
├── Procfile
├── Procfile.dev
├── README.md
├── Rakefile
├── app.json
├── config.ru
├── dev-docker-entrypoint.sh
├── dev-docker-sidekiq-entrypoint.sh
├── docker-compose.yml
├── package-lock.json
├── package.json
├── yarn.lock
└── (其他文件和目录)

目录结构介绍

• Makefile: 用于自动化构建和任务的脚本文件。
• Procfile 和 Procfile.dev: 用于定义应用程序的进程类型和启动命令。
• README.md: 项目说明文档。
• Rakefile: 用于定义 Rake 任务的脚本文件。
• app.json: 应用程序的配置文件。
• config.ru: Rack 服务器的配置文件。
• dev-docker-entrypoint.sh 和 dev-docker-sidekiq-entrypoint.sh: Docker 容器的入口点脚本。
• docker-compose.yml: Docker Compose 配置文件，用于定义和运行多容器应用程序。
• package-lock.json 和 package.json: Node.js 项目的依赖管理文件。
• yarn.lock: Yarn 包管理器的锁定文件。

2. 项目的启动文件介绍

启动文件

• Procfile: 定义了应用程序的进程类型和启动命令，例如 web 和 worker。
• Procfile.dev: 开发环境下的进程类型和启动命令。
• dev-docker-entrypoint.sh: 开发环境下 Docker 容器的入口点脚本。
• dev-docker-sidekiq-entrypoint.sh: 开发环境下 Sidekiq 服务的 Docker 容器入口点脚本。

启动命令示例

# 使用 Procfile 启动应用程序
foreman start

# 使用 Docker Compose 启动应用程序
docker-compose up

3. 项目的配置文件介绍

配置文件

• app.json: 应用程序的配置文件，包含环境变量和启动参数。
• config.ru: Rack 服务器的配置文件，用于启动应用程序。
• docker-compose.yml: Docker Compose 配置文件，定义了服务的配置和依赖关系。
• package.json: Node.js 项目的依赖管理文件，包含项目的元数据和脚本命令。

配置文件示例

app.json

{
  "name": "dawarich",
  "scripts": {
    "start": "node app.js"
  },
  "env": {
    "DATABASE_URL": "postgres://user:password@localhost:5432/dawarich"
  }
}

config.ru

require './config/environment'
run Rails.application

docker-compose.yml

version: '3'
services:
  web:
    build: .
    command: bundle exec rails s -p 3000 -b '0.0.0.0'
    volumes:
      - .:/dawarich
    ports:
      - "3000:3000"
    depends_on:
      - db
  db:
    image: postgres
    volumes:
      - db_data:/var/lib/postgresql/data
    environment:
      POSTGRES_PASSWORD: example
volumes:
  db_data:

通过以上教程，您可以了解 Dawarich 项目的目录结构、启动文件和配置文件的基本信息，以便更好地进行开发和部署。

dawarichGoogle Location History (Google Maps Timeline) self-hosted alternative.项目地址:https://gitcode.com/gh_mirrors/da/dawarich