安装和部署指南

在开始安装之前

使用和体验 LCDA 最简单的办法：直接访问 LCDA 官网 。

如果你依然想要部署属于自己的 LCDA ，请确保你能够创建并配置以下实例：Google Cloud Run ， Google Cloud Storage ， 以及一个可以公网访问的数据库，如 Amazon RDS 。

请注意，在云中部署 LCDA 需要一定的技术专业知识水平，建议您在尝试自行部署 LCDA 之前具有云服务经验。

依赖环境

• Miniconda v23.1.0+ 或 Anaconda v23.1.0+ 如果你使用Conda虚拟环境

• Python v3.7+ 如果你使用venv虚拟环境

• Git v2.30+

• Google Cloud Run

• Google Cloud Storage

• Amazon RDS

安装和部署步骤

这一章节会帮助你从零开始一步步直到本地部署 LCDA 平台。

1. 创建并进入一个新目录

   mkdir COMP208-202223-Team16
   cd COMP208-202223-Team16
   

2. 拉取源代码

   git clone https://github.com/COMP208-Team-16-2022-23/Group-Project-Code.git
   

3. 进入项目文件夹

   cd Group-Project-Code
   

4. 创建并激活Python虚拟环境

   你可以选择 venv 或 conda 来创建一个虚拟环境。

提示

• venv 适合用于短期测试，可随项目文件夹一起删除，不会影响系统环境。
• conda 适合用于长期开发，拥有更加完善的包管理功能和环境管理功能。

venv虚拟环境

这个命令将在当前目录下创建一个虚拟环境。

python -m venv .

激活虚拟环境

source ./bin/activate

.\Scripts\activate.bat

安装所需的软件包

pip install -r requirements.txt

Conda虚拟环境

创建一个名为 "COMP208 "的Conda虚拟环境，Python版本为3.10。

conda env create -f ./misc/environment.yml

激活Conda虚拟环境

conda activate COMP208

5. 配置云服务

   LCDA 设计初衷就是为了在云端部署，想要顺利运行 LCDA ，配置云服务是必不可少的一部分。各个云服务配置教程请参考其官方文档，本文不再重复赘述。

   • Amazon RDS：LCDA 使用 Amazon RDS 托管网站数据库。详细的数据库配置教程请参考官方文档 。当然，你也可以选择其他的数据库云托管服务供应商。

   • Google Cloud Storage：LCDA 使用 Google Cloud Storage 作为网站的存储服务器。详细的 Google Cloud Storage 使用教程请参考官方文档。

   • Google Cloud Run：LCDA 使用 Google Cloud Run 托管并部署网站。详细的 Google Cloud Run 使用教程请参考官方文档。

6. 配置 secret.py

   在部署和运行LCDA之前，你需要在 /secret.py 文件中配置相关信息。这个文件包含敏感信息，如API密钥、数据库密码和其他应用程序正常运行所需的秘密。在这种情况下，它还包括相关的谷歌云信息。

   下面是配置 /secret.py 的样例：

   from datetime import timedelta
   
   # DOMAIN
   DOMAIN = 'Your google cloud run domain'
   
   SECRET_KEY = 'Your secret key (i.e. a random string)'
   PERMANENT_SESSION_LIFETIME = timedelta(minutes=45)
   
   # Configuration for the database
   HOSTNAME = 'Your database hostname'
   PORT = 'Your database port'
   DATABASE = 'Your database name'
   USERNAME = 'Your database account username'
   PASSWORD = 'Your database account password'
   LOCAL_TEST = False  # set to True will ignore the above configuration and use local sqlite database called project.db
   
   # Configuration variables for email
   # configure the mail settings
   MAIL_SERVER = 'Your email server'
   MAIL_PORT = 465 # Your email server port
   MAIL_USE_SSL = True # Whether your email server uses SSL
   MAIL_USERNAME = 'Your email address'
   MAIL_PASSWORD = 'Your email account password' 
   MAIL_DEFAULT_SENDER = 'LCDA Team'
   MAIL_MAX_EMAILS = None
   
   # Configuration variables for Google Cloud Storage
   GOOGLE_APPLICATION_CREDENTIALS = {
       # Your service account key, in json format.
   }
   BUCKET_NAME = 'Your Google Cloud Storage bucket name'
   

7. 本地部署 LCDA

   export FLASK_APP=app.py
   export FLASK_ENV=development
   flask run
   

   set FLASK_APP=app.py
   set FLASK_ENV=development
   flask run
   

   $env:FLASK_APP = "app.py"
   $env:FLASK_ENV = "development"
   flask run
   

大功告成！现在即可在浏览器访问 http://127.0.0.1:5000 来访问 LCDA 了。