WebAppTemplate FARM

全栈 Web 应用程序模板 - FARM Stack

该存储库包含一个在 FARM 解决方案堆栈上运行的全堆栈 Web 应用程序模板，它代表：

• Flask ，一个后端Python Web 框架。
• Mazon Web服务，一种可以托管软件的云服务。
• React ，一个前端JavaScript Web 框架。
• MySQL ，一个关系数据库管理系统。

什么是农场？

FARM 堆栈或多或少是 LAMP 堆栈的扩展，具有以下显着变化：

• 中间件框架是明确的（Flask）
• 与 MEAN 堆栈一样，它包括应用程序表示层 (React)
• 软件运行环境被PaaS/IaaS云计算服务（AWS）取代
• 对于使用哪个操作系统没有意见

烧瓶

Flask 用于编写可以在 Web UI 和 Web 后端/数据库之间进行通信的 Web API/中间件。这是整个应用程序的核心，它将全栈应用程序的各个部分粘合在一起。

请注意，此特定模板不使用 ORM，而是使用pymysql模块。这意味着开发人员需要编写 SQL 查询，但可以最大限度地提高在数据库上运行所需的查询的复杂性。

亚马逊网络服务

AWS 是可以托管应用程序的云服务。我们可以在以下服务上托管整个软件堆栈：

• AWS Lambda用于在无服务器基础设施上托管我们的应用程序。我们还可以选择通过 Zappa 托管 Flask API，从而使部署到生产环境变得非常容易。
• AWS RDS用于托管我们的数据库。
• AWS S3用于存储各种其他对象，例如图像和文件。

这意味着开发人员可以将所有内容保留在一个平台上，并最大限度地减少 DevOps/IT 工作。

反应

React 是 Web UI 运行的框架。 React 应用程序还可以使用 NodeJS 在 AWS Lambda 上运行。

该模板使用 JavaScript / JSX，但也可以使用 TypeScript。

MySQL

MySQL是Web后端使用的关系数据库。这也可以通过其 RDS 服务托管在 AWS 上。

如何在本地运行

要运行此 Web 应用程序，需要完成以下操作：

1. 使用db/中的架构设置本地 MySQL 实例
2. 安装 API 和 UI 模块
3. 本地运行 API 和 UI

数据库设置

要设置 MySQL 实例，请执行以下步骤：

1. 创建并连接到 MySQL 数据库实例。最常见的方法是使用 MySQL Workbench 或 Linux 命令行界面上的mysql 。
2. 在实例中运行sample.sql 。它将创建一个名为SampleInventory的模式，然后初始化一个名为Inventory表。

API设置

Flask API 的代码库可以在api/目录中找到。

首次设置 (macOS)

1. 导航到该目录后，使用virtualenv farm-stack创建一个 Python 虚拟环境。
2. 使用source farm-stack/bin/activate激活它
3. 导航到api/并运行pip3 install -r requirements.txt以安装 API 所需的所有 Python 模块。
4. 打开api/目录中的dbcreds.py并根据需要编辑数据库凭据。

运行 API

1. 从上面激活虚拟环境。
2. 运行python3 app.py以在http://localhost:8080上运行 API。

用户界面设置

React UI 的代码库可以在ui/目录中找到。该模板使用yarn作为其包管理器；开发人员在添加新模块时不要混合使用npm等其他包管理器，这一点至关重要。

请注意，此模板中缺少像react-bootstrap这样的包。

首次设置 (macOS)

1. 运行yarn install以安装所需的所有依赖项。

运行用户界面

1. 运行yarn start以开发模式运行。
2. 在浏览器上导航到http://localhost:3000 。