开源项目 `awesome-italia-remote` 使用教程

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

awesome-italia-remote 是一个列出远程友好或全远程公司的项目，主要面向意大利人才。以下是该项目的目录结构及各部分介绍：

awesome-italia-remote/
├── README.md
├── LICENSE
├── data/
│   ├── companies.json
│   └── remote-policies.json
├── scripts/
│   ├── generate-list.py
│   └── update-data.sh
└── docs/
    ├── index.html
    └── styles.css

• README.md: 项目介绍文件，包含项目的基本信息和使用说明。
• LICENSE: 项目许可证文件，本项目使用 MIT 许可证。
• data/: 存储项目数据文件的目录。
  • companies.json: 包含远程公司的列表。
  • remote-policies.json: 包含远程政策的信息。
• scripts/: 包含项目脚本的目录。
  • generate-list.py: 用于生成公司列表的 Python 脚本。
  • update-data.sh: 用于更新数据的 Shell 脚本。
• docs/: 包含项目文档的目录。
  • index.html: 项目主页的 HTML 文件。
  • styles.css: 项目主页的 CSS 文件。

2. 项目的启动文件介绍

项目的启动文件主要是 scripts/generate-list.py 和 scripts/update-data.sh。

• generate-list.py: 该脚本用于从 data/companies.json 和 data/remote-policies.json 文件中读取数据，并生成公司列表。使用方法如下：

  python scripts/generate-list.py
  

• update-data.sh: 该脚本用于更新项目数据。使用方法如下：

  bash scripts/update-data.sh
  

3. 项目的配置文件介绍

项目的配置文件主要是 data/companies.json 和 data/remote-policies.json。

• companies.json: 该文件包含远程公司的列表，每个公司包含以下字段：

  • name: 公司名称。
  • url: 公司网址。
  • remote_policy: 远程政策。
  • hiring_policy: 招聘政策。

  示例：

  {
    "name": "3Bee",
    "url": "https://www.3bee.com",
    "remote_policy": "Full",
    "hiring_policy": "Direct"
  }
  

• remote-policies.json: 该文件包含远程政策的信息，每个政策包含以下字段：

  • policy_name: 政策名称。
  • description: 政策描述。

  示例：

  {
    "policy_name": "Full",
    "description": "全远程工作"
  }
  

通过以上配置文件，可以灵活地添加、修改和删除公司信息和远程政策。