Okuna API 项目启动与配置教程

Okuna API 项目启动与配置教程

okuna-api 🤖 The Okuna Social Network API 项目地址: https://gitcode.com/gh_mirrors/ok/okuna-api

1. 项目目录结构及介绍

Okuna API 是一个基于 Django 的开源项目，其目录结构如下：

okuna-api/
├── .circleci/
├── .docker/
├── .ebextensions/
├── .elasticbeanstalk/
├── docs/
├── locale/
├── media/
├── openbook/
│   ├── openbook_auth/
│   ├── openbook_categories/
│   ├── openbook_circles/
│   ├── openbook_common/
│   ├── openbook_communities/
│   ├── openbook_connections/
│   ├── openbook_devices/
│   ├── openbook_follows/
│   ├── openbook_hashtags/
│   ├── openbook_importer/
│   ├── openbook_invitations/
│   ├── openbook_lists/
│   ├── openbook_moderation/
│   ├── openbook_notifications/
│   ├── openbook_posts/
│   ├── openbook_tags/
│   ├── openbook_translation/
│   ├── templates/
│   ├── utils/
│   ├── video_encoding/
├── .bandit/
├── .coveragerc/
├── .gitignore/
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── LICENSE
├── Makefile
├── Pipfile
├── Pipfile.lock
├── README.md
├── docker-compose-full.yml
├── docker-compose-services-only.yml
├── docker-compose-test-services-only.yml
├── manage.py
├── okuna-cli.py
├── requirements-cli-only.txt
└── requirements.txt

• openbook/：包含了项目的主要业务逻辑模块。
• locale/：用于存放项目的多语言翻译文件。
• media/：存储媒体文件，如图像和视频。
• templates/：包含 HTML 模板文件。
• utils/：包含一些工具类和脚本。
• docker-compose-*.yml：Docker 的配置文件，用于定义服务。
• manage.py：Django 的管理脚本，用于数据库迁移、数据加载等操作。
• okuna-cli.py：项目自定义的命令行工具，用于启动和停止服务。

2. 项目的启动文件介绍

项目的启动主要通过 okuna-cli.py 脚本进行。该脚本提供了两种操作模式：全模式和仅服务模式。

• 全模式：适用于移动端或网页应用的开发，启动完整的 Okuna 实例。
• 仅服务模式：仅启动数据库、Redis、作业调度器和作业工作器服务，适用于 API 开发。

启动全模式：

python okuna-cli.py up-full

启动仅服务模式：

python okuna-cli.py up-services-only

3. 项目的配置文件介绍

项目的配置主要通过以下几个文件进行：

• Pipfile 和 Pipfile.lock：用于定义项目依赖的 Python 包。
• docker-compose-*.yml：Docker 配置文件，定义了项目运行所需的各项服务及其配置。

例如，docker-compose-full.yml 文件中定义了数据库、Redis、前端服务、后端服务等多个服务，以及它们之间的连接和配置。

在开发环境中，可以通过修改这些配置文件来调整项目设置，满足不同的开发需求。

okuna-api 🤖 The Okuna Social Network API 项目地址: https://gitcode.com/gh_mirrors/ok/okuna-api